FBPropertyViewList Class Reference

FBPropertyViewList Class Reference

#include <mobu-python-api.h>

Class Description

FBProperty View List.

Hold list of description for view set.

+ Inheritance diagram for FBPropertyViewList:

Public Member Functions

 __reduce__ ()
 
bool IsEditable (FBPropertyViewList arg1)
 Is property view list editable. More...
 
FBPropertyViewDefinition AddPropertyView (FBPropertyViewList arg1, FBProperty arg2, str arg3)
 Add property view. More...
 
bool RemovePropertyView (FBPropertyViewList arg1, FBPropertyViewDefinition arg2)
 Remove property view from view list. More...
 
FBPropertyViewDefinition FindPropertyView (FBPropertyViewList arg1, str arg2)
 Find property view for pPropertyName in this list. More...
 
 __init__ (...)
 

Member Function Documentation

__init__ (   ...)

Python Docstring:

Raises an exception
This class cannot be instantiated from Python 

C++ Constructors:
The reference documentation for the following C++ symbols may contain additional relevant information.

__reduce__ ( )
FBPropertyViewDefinition AddPropertyView ( FBPropertyViewList  arg1,
FBProperty  arg2,
str  arg3 
)

Add property view.

Python Docstring:

AddPropertyView( (FBPropertyViewList)arg1, (FBProperty)arg2, (str)arg3) -> FBPropertyViewDefinition 

C++ Signature:

ORSDK2018::FBPropertyViewDefinition * AddPropertyView(ORSDK2018::FBProperty * pProperty, const char * pHierarchy) 
Parameters
pPropertyProperty to add.
pHierarchyHierarchy under which property view should be created, each level name is separated by dot (for example "Degrees of Freedom.Translation").
Returns
created object (should not be called on non editable view list).
FBPropertyViewDefinition FindPropertyView ( FBPropertyViewList  arg1,
str  arg2 
)

Find property view for pPropertyName in this list.

Python Docstring:

FindPropertyView( (FBPropertyViewList)arg1, (str)arg2) -> FBPropertyViewDefinition 

C++ Signature:

ORSDK2018::FBPropertyViewDefinition * FindPropertyView(const char * pPropertyName) 
bool IsEditable ( FBPropertyViewList  arg1)

Is property view list editable.

Python Docstring:

IsEditable( (FBPropertyViewList)arg1) -> bool 

C++ Signature:

bool IsEditable() 
bool RemovePropertyView ( FBPropertyViewList  arg1,
FBPropertyViewDefinition  arg2 
)

Remove property view from view list.

Python Docstring:

RemovePropertyView( (FBPropertyViewList)arg1, (FBPropertyViewDefinition)arg2) -> bool 

C++ Signature:

bool RemovePropertyView(ORSDK2018::FBPropertyViewDefinition * pPropertyViewDefinition) 
Parameters
pPropertyViewDefinitionProperty view definition to destroy.
Returns
true when pPropertyViewDefinition got removed and free (should not be called on non editable view list).