FBPropertyViewManager Class Reference

FBProperty View Manager. More...

#include <pyfbsdk.h>

Inheritance diagram for FBPropertyViewManager:

Public Member Functions
FBViewDefinition	AddPropertyView (str pClassName, str pPropertyName, str pHierarchy)
	Add property view to global ('All') view set.
FBViewList	CreatePropertyList (FBComponent pObject, FBViewType pViewType, str pName)
	Create new property view list.
FBViewList	FindPropertyList (FBComponent pObject, FBViewType pViewType, str pName)
	Find property view list.
	HidePropertyView (str pClassName, str pPropertyName, bool pHide)
	Hide property view in global ('All') view set.
	RefreshPropertyViews ()
	Force refresh of browsing property tool.
bool	RemovePropertyList (FBComponent pObject, FBViewType pViewType, str pName)
	Remove property view list (only if editable).
bool	RemovePropertyView (str pClassName, str pPropertyName)
	Remove property view from global ('All') view set.
Public Member Functions inherited from FBComponent
	FBComponent ()
	Constructor.
str	ClassName ()
	Get the class name.
	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.
	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.
bool	FBCreate ()
	Open Reality Creation function.
	FBDelete ()
	Open Reality deletion function.
	FBDestroy ()
	Open Reality destruction function.
FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).
bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.
FBFileReference	GetOwnerFileReference (p0)
	Get the owner FileReference object.
	HardSelect ()
	HardSelect.
bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.
bool	Is (int pTypeId)
	Returns true if object is of type TypeId.
bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessNamespaceHierarchy.
bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessObjectNamespace.
int	PropertyAdd (FBProperty pProperty)
	Add a property to the component's property manager.
bool	PropertyAddReferenceProperty (FBProperty pReferenceProperty)
	Add a reference property to the component's property manager.
FBProperty	PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
	Create user or dynamic property.
	PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.
	PropertyRemove (FBProperty pProperty)
	Remove a Property from the component's Property manager.
	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.
	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

Additional Inherited Members
Public Attributes inherited from FBComponent
FBListComponent	Components
	List: List of components.
str	LongName
	Read Write Property: Name and namespace for object.
str	Name
	Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.
FBListComponent	Parents
	List: Parents.
FBManager	PropertyList
	Read Only Property: Manages all of the properties for the component.
bool	Selected
	Read Write Property: Selected property.
int	TypeInfo
	Contains the Type information of the object.
Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.
int	TypeInfo
	TypeInfo.

Detailed Description

FBProperty View Manager.

Interface to create new property views. There are two ways of creating properties view:on library load using AddPropertyView, RemovePropertyView, HidePropertyView - example can be found in \OpenRealitySDK\Samples\constraints\CharacterSolver\HIK2014Solverwhile application is running using FBPropertyViewList - example can be found in \bin\config\Scripts\Samples\Properties\PropertyViewManager.py

See sample: PropertyViewManager.py.

Member Function Documentation

AddPropertyView()

FBViewDefinition AddPropertyView	(	str	pClassName,
		str	pPropertyName,
		str	pHierarchy
	)

Add property view to global ('All') view set.

Parameters

pClassName	Property owner class name (pClassName if won't be found, a new entry for this class is created).
pPropertyName	Property name.
pHierarchy	Hierarchy under which property view should be created, each level name is separated by dot (for example "Degrees of Freedom.Translation").

Returns

created object.

Note

This call should be used on library registration, doesn't cause tool refresh.

CreatePropertyList()

FBViewList CreatePropertyList	(	FBComponent	pObject,
		FBViewType	pViewType,
		str	pName
	)

Create new property view list.

Parameters

pObject	Property view set attached to.
pViewType	Property view set type.
pName	Name for new view list.

Returns

created object.

FindPropertyList()

FBViewList FindPropertyList	(	FBComponent	pObject,
		FBViewType	pViewType,
		str	pName
	)

Find property view list.

Parameters

pObject	Property view set attached to.
pViewType	Property view set type.
pName	Name of view set.

Returns

Found property view set object or NULL.

HidePropertyView()

HidePropertyView	(	str	pClassName,
		str	pPropertyName,
		bool	pHide
	)

Hide property view in global ('All') view set.

Parameters

pClassName	Property owner class name.
pPropertyName	Property name.
pHide	Show/Hide.

Note

This call should be used on library registration, doesn't cause tool refresh.

RefreshPropertyViews()

RefreshPropertyViews

(

)

Force refresh of browsing property tool.

RemovePropertyList()

bool RemovePropertyList	(	FBComponent	pObject,
		FBViewType	pViewType,
		str	pName
	)

Remove property view list (only if editable).

Parameters

pObject	Property view set attached to.
pViewType	Property view set type.
pName	Name for property view list.

Returns

True if successful.

RemovePropertyView()

bool RemovePropertyView	(	str	pClassName,
		str	pPropertyName
	)

Remove property view from global ('All') view set.

Parameters

pClassName	Property owner class name.
pPropertyName	Property name.

Returns

true if succeed (should not be call on system views).

Note

This call should be used on library registration, doesn't cause tool refresh.