FBPropertyViewManager Class Reference

FBPropertyViewManager Class Reference

#include <mobu-python-api.h>

Class 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
  • while application is running using FBPropertyViewList - example can be found in .py
+ Inheritance diagram for FBPropertyViewManager:

Public Member Functions

 __reduce__ ()
 
FBPropertyViewList CreatePropertyList (FBPropertyViewManager arg1, FBComponent arg2, FBPropertyViewType arg3, str arg4)
 Create new property view list. More...
 
 __init__ (object arg1)
 Constructor. More...
 
bool RemovePropertyList (FBPropertyViewManager arg1, FBComponent arg2, FBPropertyViewType arg3, str arg4)
 Remove property view list (only if editable). More...
 
FBPropertyViewList FindPropertyList (FBPropertyViewManager arg1, FBComponent arg2, FBPropertyViewType arg3, str arg4)
 Find property view list. More...
 
FBPropertyViewDefinition AddPropertyView (FBPropertyViewManager arg1, str arg2, str arg3, str arg4)
 Add property view to global ('All') view set. More...
 
bool RemovePropertyView (FBPropertyViewManager arg1, str arg2, str arg3)
 Remove property view from global ('All') view set. More...
 
 HidePropertyView (FBPropertyViewManager arg1, str arg2, str arg3, object arg4)
 Hide property view in global ('All') view set. More...
 
 RefreshPropertyViews (FBPropertyViewManager arg1)
 Force refresh of browsing property tool. More...
 
- Public Member Functions inherited from FBComponent
 __reduce__ ()
 
FBPropertyList PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2)
 Get list of properties which have been modified since last loading. More...
 
str ClassName (FBComponent arg1)
 Get the class name. More...
 
 DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
 Disable a specific Object Flags. More...
 
 EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
 Enable a specific Object Flags. More...
 
bool FBCreate (FBComponent arg1)
 Open Reality Creation function. More...
 
 FBDelete (FBComponent arg1)
 Open Reality deletion function. More...
 
 FBDestroy (FBComponent arg1)
 Open Reality destruction function. More...
 
FBObjectFlag GetObjectFlags (FBComponent arg1)
 Get all Object Flags (concatenated). More...
 
bool GetObjectStatus (FBComponent arg1, FBObjectStatus arg2)
 Check to see if an object status is enabled. More...
 
bool HasObjectFlags (FBComponent arg1, FBObjectFlag arg2)
 Check whether a specific object flag is enabled. More...
 
bool Is (FBComponent arg1, object arg2)
 Returns true if object is of type TypeId. More...
 
bool ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
 ProcessNamespaceHierarchy. More...
 
bool ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
 ProcessObjectNamespace. More...
 
int PropertyAdd (FBComponent arg1, FBProperty arg2)
 Add a property to the component's property manager. More...
 
bool PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2)
 Add a reference property to the component's property manager. More...
 
object PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7)
 Create user or dynamic property. More...
 
 PropertyRemove (FBComponent arg1, FBProperty arg2)
 Remove a Property from the component's Property manager. More...
 
 SetObjectFlags (FBComponent arg1, FBObjectFlag arg2)
 SetObjectFlags. More...
 
 SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3)
 Enable/Disable a specific Object Status. More...
 
 HardSelect (FBComponent arg1)
 HardSelect. More...
 
object GetOwnerFileReference (FBComponent arg1)
 Get the owner FileReference object. More...
 
 __init__ (...)
 Constructor. More...
 
- Public Member Functions inherited from FBPlug
 __reduce__ ()
 
bool BeginChange (FBPlug arg1)
 Begins a change on multiple plugs. More...
 
str ClassName (FBPlug arg1)
 internal System vars. More...
 
bool ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
 Add a destination connection. More...
 
bool ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
 Add a destination connection. More...
 
bool ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
 Add a source connection. More...
 
bool ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
 Add a source connection. More...
 
 DisconnectAllDst (FBPlug arg1)
 Remove all destination connections. More...
 
 DisconnectAllSrc (FBPlug arg1)
 Remove all source connections. More...
 
bool DisconnectDst (FBPlug arg1, FBPlug arg2)
 Remove a destination connection. More...
 
bool DisconnectDstAt (FBPlug arg1, object arg2)
 Remove a destination connection at a specified index. More...
 
bool DisconnectSrc (FBPlug arg1, FBPlug arg2)
 Remove a source connection. More...
 
bool DisconnectSrcAt (FBPlug arg1, object arg2)
 Remove a source connection at a specified index. More...
 
 EndChange (FBPlug arg1)
 Ends a change on multiple plugs. More...
 
object GetDst (FBPlug arg1, object arg2)
 Get a destination connection's plug at specified index. More...
 
int GetDstCount (FBPlug arg1)
 Get destination connection count. More...
 
FBConnectionType GetDstType (FBPlug arg1, object arg2)
 Get a destination connection's type at specified index. More...
 
object GetOwned (FBPlug arg1, object arg2)
 Get the owned plug at specified index. More...
 
int GetOwnedCount (FBPlug arg1)
 Get the owned plug count. More...
 
object GetOwner (FBPlug arg1)
 Get the owner of this plug. More...
 
object GetSrc (FBPlug arg1, object arg2)
 Get a source connection's plug at specified index. More...
 
int GetSrcCount (FBPlug arg1)
 Get source connection count. More...
 
FBConnectionType GetSrcType (FBPlug arg1, object arg2)
 Get a source connection's type at specified index. More...
 
bool Is (FBPlug arg1, object arg2)
 Is( int pTypeId ) More...
 
bool IsSDKComponent (FBPlug arg1)
 Return whether or not item is an SDK component. More...
 
 MoveSrcAt (...)
 
bool ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3)
 Replace a destination connection at a specified index. More...
 
bool ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3)
 Replace a source connection at a specified index. More...
 
bool SwapSrc (FBPlug arg1, object arg2, object arg3)
 Swap source connection at index A with source connection at index B. More...
 
 SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
 Set the plug's self modification flag. More...
 
bool GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2)
 Tell if the plug's self has changed. More...
 
 SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
 Set the plug's owned property/object's modification flag. More...
 
bool GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2)
 Tell if the plug's content has changed. More...
 
int GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4)
 Get plug's modified src/dst property/object connection added/removed List. More...
 
bool RevertModification (FBPlug arg1, FBPlugModificationFlag arg2)
 Revert the plug's modification to original status. More...
 
 __init__ (...)
 
method staticmethod (function)
 
- Public Member Functions inherited from FBPythonWrapper
 __reduce__ ()
 
 __init__ (...)
 

Additional Inherited Members

- Public Attributes inherited from FBComponent
object OwnerNamespace
 
ORSDK2018::FBPropertyListComponent Components
 List: List of components. More...
 
ORSDK2018::FBPropertyString Name
 Read Write Property: Unique name of object. More...
 
ORSDK2018::FBPropertyString LongName
 Read Write Property: Name and namespace for object. More...
 
object FullName
 
ORSDK2018::FBPropertyListComponent Parents
 List: Parents. More...
 
ORSDK2018::FBPropertyManager PropertyList
 Read Only Property: Manages all of the properties for the component. More...
 
FBPropertyBool Selected
 Read Write Property: Selected property. More...
 
- Public Attributes inherited from FBPythonWrapper
object OnUnbind
 

Member Function Documentation

__init__ ( object  arg1)

Constructor.

Python Docstring:

__init__( (object)arg1) -> None 

C++ Signature:

 FBPropertyViewManager(HIObject pObject = ((void *) 0)) 

Protected constructor, use TheOne() access instead.

Parameters
pObjectInternal parent object(default=NULL).
__reduce__ ( )
FBPropertyViewDefinition AddPropertyView ( FBPropertyViewManager  arg1,
str  arg2,
str  arg3,
str  arg4 
)

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

Python Docstring:

AddPropertyView( (FBPropertyViewManager)arg1, (str)arg2, (str)arg3, (str)arg4) -> FBPropertyViewDefinition 

C++ Signature:

ORSDK2018::FBPropertyViewDefinition * AddPropertyView(const char * pClassName, const char * pPropertyName, const char * pHierarchy) 
Parameters
pClassNameProperty owner class name (pClassName if won't be found, a new entry for this class is created).
pPropertyNameProperty name.
pHierarchyHierarchy under which property view should be created, each level name is separated by dot (for example "Degrees of Freedom.Translation").
Note
This call should be used on library registration, doesn't cause tool refresh.
Returns
created object.
FBPropertyViewList CreatePropertyList ( FBPropertyViewManager  arg1,
FBComponent  arg2,
FBPropertyViewType  arg3,
str  arg4 
)

Create new property view list.

Python Docstring:

CreatePropertyList( (FBPropertyViewManager)arg1, (FBComponent)arg2, (FBPropertyViewType)arg3, (str)arg4) -> FBPropertyViewList 

C++ Signature:

ORSDK2018::FBPropertyViewList * CreatePropertyList(ORSDK2018::FBComponent * pObject, FBPropertyViewType pViewType, const char * pName) 
Parameters
pObjectProperty view set attached to.
pViewTypeProperty view set type.
pNameName for new view list.
Returns
created object.
FBPropertyViewList FindPropertyList ( FBPropertyViewManager  arg1,
FBComponent  arg2,
FBPropertyViewType  arg3,
str  arg4 
)

Find property view list.

Python Docstring:

FindPropertyList( (FBPropertyViewManager)arg1, (FBComponent)arg2, (FBPropertyViewType)arg3, (str)arg4) -> FBPropertyViewList 

C++ Signature:

ORSDK2018::FBPropertyViewList * FindPropertyList(ORSDK2018::FBComponent * pObject, FBPropertyViewType pViewType, const char * pName) 
Parameters
pObjectProperty view set attached to.
pViewTypeProperty view set type.
pNameName of view set.
Returns
Found property view set object or NULL.
HidePropertyView ( FBPropertyViewManager  arg1,
str  arg2,
str  arg3,
object  arg4 
)

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

Python Docstring:

HidePropertyView( (FBPropertyViewManager)arg1, (str)arg2, (str)arg3, (object)arg4) -> None 

C++ Signature:

void HidePropertyView(const char * pClassName, const char * pPropertyName, bool pHide) 
Parameters
pClassNameProperty owner class name.
pPropertyNameProperty name.
pHideShow/Hide.
Note
This call should be used on library registration, doesn't cause tool refresh.
RefreshPropertyViews ( FBPropertyViewManager  arg1)

Force refresh of browsing property tool.

Python Docstring:

RefreshPropertyViews( (FBPropertyViewManager)arg1) -> None 

C++ Signature:

void RefreshPropertyViews() 
bool RemovePropertyList ( FBPropertyViewManager  arg1,
FBComponent  arg2,
FBPropertyViewType  arg3,
str  arg4 
)

Remove property view list (only if editable).

Python Docstring:

RemovePropertyList( (FBPropertyViewManager)arg1, (FBComponent)arg2, (FBPropertyViewType)arg3, (str)arg4) -> bool 

C++ Signature:

bool RemovePropertyList(ORSDK2018::FBComponent * pObject, FBPropertyViewType pViewType, const char * pName) 
Parameters
pObjectProperty view set attached to.
pViewTypeProperty view set type.
pNameName for property view list.
Returns
True if successful.
bool RemovePropertyView ( FBPropertyViewManager  arg1,
str  arg2,
str  arg3 
)

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

Python Docstring:

RemovePropertyView( (FBPropertyViewManager)arg1, (str)arg2, (str)arg3) -> bool 

C++ Signature:

bool RemovePropertyView(const char * pClassName, const char * pPropertyName) 
Parameters
pClassNameProperty owner class name.
pPropertyNameProperty 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.