Marker set class. More...
#include <pyfbsdk_generated.h>
Public Member Functions | |
FBMarkerSet (str pName) | |
Constructor. | |
int | AddMarker (FBSkeletonNodeId pNodeId, FBModel pModel=None, bool pIsOriented=False) |
Add a marker to the marker set. | |
BeginTransaction () | |
Specify that you are about to call a group of functions. | |
EndTransaction () | |
Specify that you are done calling a group of functions. | |
bool | GetLinkToModelOk () |
Get the marker set association correctness. | |
int | GetMarkerCount (FBSkeletonNodeId pNodeId=kFBSkeletonInvalidIndex) |
Get the number of marker in the set. | |
FBModel | GetMarkerModel (FBSkeletonNodeId pNodeId, int pMarkerIndex) |
Get the model associated with a marker. | |
str | GetMarkerName (FBSkeletonNodeId pNodeId, int pMarkerIndex) |
Get the name of marker at index pMarkerIndex. | |
bool | GetMarkerOriented (FBSkeletonNodeId pNodeId, int pMarkerIndex) |
Is marker orientated ? | |
GetMarkerROffset (FBSkeletonNodeId pNodeId, int pMarkerIndex, FBRVector pROffset) | |
Get/Set a marker rotation. | |
int | GetMarkerSetVisibility () |
Get the marker set visibility. | |
GetMarkerTOffset (FBSkeletonNodeId pNodeId, int pMarkerIndex, FBTVector pTOffset) | |
Get/Set a marker translation. | |
bool | GetMarkerUsed (FBSkeletonNodeId pNodeId, int pMarkerIndex) |
Is marker used ? | |
FBModel | GetReferenceModel () |
Get the reference model associated with this marker set. | |
int | GetUsedMarkerCount (FBSkeletonNodeId pNodeId=kFBSkeletonInvalidIndex) |
Get the number of used marker in the set. | |
SetMarkerModel (FBSkeletonNodeId pNodeId, int pMarkerIndex, FBModel pModel) | |
Associate a model to a marker. | |
SetMarkerName (FBSkeletonNodeId pNodeId, int pMarkerIndex, str pMarkerName) | |
Set the name of marker at index pMarkerIndex. | |
SetMarkerOriented (FBSkeletonNodeId pNodeId, int pMarkerIndex, bool pIsOriented) | |
Set marker to be oriented or not. | |
SetMarkerROffset (FBSkeletonNodeId pNodeId, int pMarkerIndex, FBRVector pROffset) | |
SetMarkerSetVisibility (bool pVisibility) | |
Set the marker set visibility. | |
SetMarkerTOffset (FBSkeletonNodeId pNodeId, int pMarkerIndex, FBTVector pTOffset) | |
SetMarkerUsed (FBSkeletonNodeId pNodeId, int pMarkerIndex, bool pUsed) | |
Set marker to be used or not. | |
bool | SetMultipleMarkerModels (FBModelList pModelList) |
Associate multiple models to markers, matching them by name. | |
SetReferenceModel (FBModel pReferenceModel) | |
Associate a model to a marker. | |
![]() | |
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 | |
![]() | |
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. | |
![]() | |
str | ClassGroupName |
ClassGroupName of the object. | |
int | TypeInfo |
TypeInfo. | |
Marker set class.
These classes are under development and may change dramatically between versions.
FBMarkerSet | ( | str | pName | ) |
Constructor.
pName | Name of new marker set. |
int AddMarker | ( | FBSkeletonNodeId | pNodeId, |
FBModel | pModel = None , |
||
bool | pIsOriented = False |
||
) |
Add a marker to the marker set.
pNodeId | Id of Actor skeleton node. For hand, use the "C" index (ex:kFBSkeletonLeftThumbCIndex, kFBSkeletonLeftMiddleCIndex...) |
pModel | The model to be associated with the marker (Optional). |
pIsOriented | Set marker to be oriented or not (Optional). |
BeginTransaction | ( | ) |
Specify that you are about to call a group of functions.
EndTransaction | ( | ) |
Specify that you are done calling a group of functions.
bool GetLinkToModelOk | ( | ) |
Get the marker set association correctness.
int GetMarkerCount | ( | FBSkeletonNodeId | pNodeId = kFBSkeletonInvalidIndex | ) |
Get the number of marker in the set.
pNodeId | If specified, obtain the number of marker for the specific node. |
FBModel GetMarkerModel | ( | FBSkeletonNodeId | pNodeId, |
int | pMarkerIndex | ||
) |
Get the model associated with a marker.
pNodeId | Id of Actor skeleton node. |
pMarkerIndex | Index of marker. |
str GetMarkerName | ( | FBSkeletonNodeId | pNodeId, |
int | pMarkerIndex | ||
) |
Get the name of marker at index pMarkerIndex.
pNodeId | Id of Actor skeleton node. |
pMarkerIndex | Index of marker to access. |
bool GetMarkerOriented | ( | FBSkeletonNodeId | pNodeId, |
int | pMarkerIndex | ||
) |
Is marker orientated ?
pNodeId | Id of Actor body node. |
pMarkerIndex | Index of marker to access. |
GetMarkerROffset | ( | FBSkeletonNodeId | pNodeId, |
int | pMarkerIndex, | ||
FBRVector | pROffset | ||
) |
Get/Set a marker rotation.
pNodeId | Id of Actor skeleton node. |
pMarkerIndex | Index of marker to access. |
pROffset | Current or new value of the marker rotation. |
int GetMarkerSetVisibility | ( | ) |
Get the marker set visibility.
GetMarkerTOffset | ( | FBSkeletonNodeId | pNodeId, |
int | pMarkerIndex, | ||
FBTVector | pTOffset | ||
) |
Get/Set a marker translation.
pNodeId | Id of Actor skeleton node. |
pMarkerIndex | Index of marker to access. |
pTOffset | Current or new value of the marker translation. |
bool GetMarkerUsed | ( | FBSkeletonNodeId | pNodeId, |
int | pMarkerIndex | ||
) |
Is marker used ?
pNodeId | Id of Actor skeleton node. |
pMarkerIndex | Index of marker to access. |
FBModel GetReferenceModel | ( | ) |
Get the reference model associated with this marker set.
int GetUsedMarkerCount | ( | FBSkeletonNodeId | pNodeId = kFBSkeletonInvalidIndex | ) |
Get the number of used marker in the set.
pNodeId | If specified, obtain the number of used marker for the specific node. |
SetMarkerModel | ( | FBSkeletonNodeId | pNodeId, |
int | pMarkerIndex, | ||
FBModel | pModel | ||
) |
Associate a model to a marker.
pNodeId | Id of Actor skeleton node. |
pMarkerIndex | Index of marker. |
pModel | Model to be associated to the marker. |
SetMarkerName | ( | FBSkeletonNodeId | pNodeId, |
int | pMarkerIndex, | ||
str | pMarkerName | ||
) |
Set the name of marker at index pMarkerIndex.
pNodeId | Id of Actor skeleton node. |
pMarkerIndex | Index of marker to access. |
pMarkerName | New name to give to the marker. |
SetMarkerOriented | ( | FBSkeletonNodeId | pNodeId, |
int | pMarkerIndex, | ||
bool | pIsOriented | ||
) |
Set marker to be oriented or not.
pNodeId | Id of Actor skeleton node. |
pMarkerIndex | Index of marker to access. |
pIsOriented | Oriented or not. |
SetMarkerROffset | ( | FBSkeletonNodeId | pNodeId, |
int | pMarkerIndex, | ||
FBRVector | pROffset | ||
) |
SetMarkerSetVisibility | ( | bool | pVisibility | ) |
Set the marker set visibility.
pVisibility | True will make to markers visible, false will hide them. |
SetMarkerTOffset | ( | FBSkeletonNodeId | pNodeId, |
int | pMarkerIndex, | ||
FBTVector | pTOffset | ||
) |
SetMarkerUsed | ( | FBSkeletonNodeId | pNodeId, |
int | pMarkerIndex, | ||
bool | pUsed | ||
) |
Set marker to be used or not.
pNodeId | Id of Actor skeleton node. |
pMarkerIndex | Index of marker to access. |
pUsed | Used or not. |
bool SetMultipleMarkerModels | ( | FBModelList | pModelList | ) |
Associate multiple models to markers, matching them by name.
pModelList | A list of models to be matched with marker names. |
SetReferenceModel | ( | FBModel | pReferenceModel | ) |
Associate a model to a marker.
pReferenceModel | Model to be associated to the marker. |