FBPlug Class Reference
 
 
 
FBPlug Class Reference

#include <mobu-python-api.h>


Class Description

Connections Basic Open Reality SDK Element. Most elements that are available in the SDK inherit from this base class since FBComponent and FBProperty inherit from FBPlug. Basically, all objects can be connected together because they are all "plugs". To simplify the graph, you can think of a "source" connection as a child, and a "destination" connection as a parent. Also, it is correct to assume that a source affect/work on its destination. For example, a shader applied on an object would be seen as the source while the object is the destination. So FBPlug is a set of functions that enables you to control those connections with flexibility and ease.

Inheritance diagram for FBPlug:
FBPythonWrapper FBComponent FBProperty FBActionManager FBActorFace FBAnimationLayer FBAnimationNode FBApplication FBAssetItem FBAssetMng FBAudioClip FBAudioIn FBAudioOut FBBox FBCharacterMarkerSet FBCluster FBConstraintManager FBControlSet FBDeck FBDeformer FBDeviceInstrument FBDeviceOpticalMarker FBEvaluateManager FBFbxOptions FBFCurve FBFileMonitoringManager FBFilter FBFolder FBGenericMenu FBGenericMenuItem FBGeometry FBImage FBKeyControl FBKeyingGroup FBLogger FBManipulator FBMarkerSet FBMenuManager FBModelOpticalAdvanced FBModelTemplate FBModelVertexData FBMotionClip FBNamespace FBOpticalGap FBOpticalSegment FBPlayerControl FBPointCacheFile FBPointCacheManager FBPose FBProfiler FBProgress FBPropertyViewManager FBReferenceTime FBRenderer FBRendererCallback FBRigidBody FBScene FBSpreadPart FBStory FBStoryClip FBStoryFolder FBSystem FBTake FBTimeWarpManager FBTreeNode FBVideoGrabber FBVisualComponent FBPropertyAction FBPropertyAnimatable FBPropertyBool FBPropertyColor FBPropertyColorAndAlpha FBPropertyComponent FBPropertyDouble FBPropertyEnum FBPropertyFloat FBPropertyInt FBPropertyList FBPropertyListComponent FBPropertyListTreeNode FBPropertyString FBPropertyStringList FBPropertyTime FBPropertyTimeCode FBPropertyVector2d FBPropertyVector3d FBPropertyVector4d

Public Member Functions

def  __reduce__ ()
def  BeginChange ()
def  ClassName ()
def  ConnectDst ()
def  ConnectDstAt ()
def  ConnectSrc ()
def  ConnectSrcAt ()
def  DisconnectAllDst ()
def  DisconnectAllSrc ()
def  DisconnectDst ()
def  DisconnectDstAt ()
def  DisconnectSrc ()
def  DisconnectSrcAt ()
def  EndChange ()
def  GetDst ()
def  GetDstCount ()
def  GetDstType ()
def  GetOwned ()
def  GetOwnedCount ()
def  GetOwner ()
def  GetSrc ()
def  GetSrcCount ()
def  GetSrcType ()
def  Is ()
def  IsSDKComponent ()
def  MoveSrcAt ()
def  ReplaceDstAt ()
def  ReplaceSrcAt ()
def  SwapSrc ()
def  SetSelfModified ()
def  GetSelfModified ()
def  SetContentModified ()
def  GetContentModified ()
def  GetPlugConnectionModifiedList ()
def  RevertModification ()
def  __init__ ()
def  PrintClassDefinitions ()

Public Attributes

object  OnUnbind

Member Function Documentation

def __reduce__ ( )

Reimplemented from FBPythonWrapper.

Reimplemented in FBActionManager, FBActor, FBActorFace, FBAnimationLayer, FBAnimationNode, FBApplication, FBArrowButton, FBAssetFile, FBAssetFolder, FBAssetItem, FBAssetMng, FBAudioClip, FBAudioIn, FBAudioOut, FBBox, FBBoxPlaceHolder, FBBrowsingProperty, FBButton, FBCamera, FBCameraStereo, FBCameraSwitcher, FBCharacter, FBCharacterExtension, FBCharacterFace, FBCharacterMarkerSet, FBCharacterPose, FBCharacterSolver, FBCluster, FBComponent, FBConstraint, FBConstraintManager, FBConstraintRelation, FBConstraintSolver, FBControlSet, FBDeck, FBDeformer, FBDeformerPointCache, FBDevice, FBDeviceInstrument, FBDeviceOptical, FBDeviceOpticalMarker, FBEdit, FBEditColor, FBEditNumber, FBEditProperty, FBEditPropertyModern, FBEditTimeCode, FBEditVector, FBEvaluateManager, FBFCurve, FBFCurveEditor, FBFbxOptions, FBFileMonitoringManager, FBFileReference, FBFilter, FBFolder, FBGenericMenu, FBGenericMenuItem, FBGeometry, FBGlobalLight, FBGroup, FBHUD, FBHUDBloopSlateElement, FBHUDElement, FBHUDFlashElement, FBHUDRectElement, FBHUDTextElement, FBHUDTextureElement, FBHUDTimelineElement, FBHandle, FBImage, FBImageContainer, FBKeyControl, FBKeyingGroup, FBLabel, FBLayeredTexture, FBLayout, FBLayoutRegion, FBLight, FBList, FBLogger, FBManipulator, FBMarkerSet, FBMaterial, FBMemo, FBMenuManager, FBMesh, FBModel, FBModelCube, FBModelMarker, FBModelMarkerOptical, FBModelNull, FBModelOptical, FBModelOpticalAdvanced, FBModelPath3D, FBModelPlaceHolder, FBModelPlane, FBModelRoot, FBModelSkeleton, FBModelTemplate, FBModelVertexData, FBMotionClip, FBNamespace, FBNote, FBNurbs, FBObjectPose, FBOpticalGap, FBOpticalSegment, FBPatch, FBPhysicalProperties, FBPlayerControl, FBPlotPopup, FBPointCacheFile, FBPointCacheManager, FBPopup, FBPose, FBProfiler, FBProgress, FBProperty, FBPropertyAction, FBPropertyAnimatable, FBPropertyAnimatableAction, FBPropertyAnimatableBool, FBPropertyAnimatableColor, FBPropertyAnimatableColorAndAlpha, FBPropertyAnimatableDouble, FBPropertyAnimatableEnum, FBPropertyAnimatableInt, FBPropertyAnimatableInt64, FBPropertyAnimatableTime, FBPropertyAnimatableTimeCode, FBPropertyAnimatableUInt64, FBPropertyAnimatableVector2d, FBPropertyAnimatableVector3d, FBPropertyAnimatableVector4d, FBPropertyBool, FBPropertyColor, FBPropertyColorAndAlpha, FBPropertyComponent, FBPropertyConnectionEditor, FBPropertyDouble, FBPropertyEnum, FBPropertyFloat, FBPropertyInt, FBPropertyList, FBPropertyListActor, FBPropertyListActorFace, FBPropertyListAudioClip, FBPropertyListAudioIn, FBPropertyListAudioOut, FBPropertyListBox, FBPropertyListCamera, FBPropertyListCharacter, FBPropertyListCharacterExtension, FBPropertyListCharacterFace, FBPropertyListCharacterMarkerSet, FBPropertyListCharacterPose, FBPropertyListComponent, FBPropertyListConstraint, FBPropertyListConstraintSolver, FBPropertyListControlSet, FBPropertyListDeck, FBPropertyListDeformer, FBPropertyListDevice, FBPropertyListFileReference, FBPropertyListFolder, FBPropertyListGroup, FBPropertyListHUD, FBPropertyListHUDElement, FBPropertyListHandle, FBPropertyListKeyingGroup, FBPropertyListLight, FBPropertyListMarkerSet, FBPropertyListMaterial, FBPropertyListModel, FBPropertyListModelOptical, FBPropertyListModelSkeleton, FBPropertyListMotionClip, FBPropertyListNamespace, FBPropertyListNote, FBPropertyListObject, FBPropertyListObjectPose, FBPropertyListPhysicalProperties, FBPropertyListPivot, FBPropertyListPose, FBPropertyListRendererCallback, FBPropertyListSet, FBPropertyListShader, FBPropertyListStoryClip, FBPropertyListStoryDetails, FBPropertyListStoryFolder, FBPropertyListStorySubTrack, FBPropertyListStoryTrack, FBPropertyListTake, FBPropertyListTexture, FBPropertyListTreeNode, FBPropertyListUserObject, FBPropertyListVideoClip, FBPropertyListVideoIn, FBPropertyListVideoOut, FBPropertyString, FBPropertyStringList, FBPropertyTime, FBPropertyTimeCode, FBPropertyVector2d, FBPropertyVector3d, FBPropertyVector4d, FBPropertyViewManager, FBReferenceTime, FBRenderer, FBRendererCallback, FBRigidBody, FBScene, FBScrollBox, FBSet, FBShader, FBShaderLighted, FBShaderShadowLive, FBSlider, FBSpread, FBSpreadCell, FBSpreadColumn, FBSpreadPart, FBSpreadRow, FBStory, FBStoryClip, FBStoryFolder, FBStoryTrack, FBSurface, FBSystem, FBTabPanel, FBTake, FBTexture, FBThermometer, FBTimeWarpManager, FBTool, FBTree, FBTreeNode, FBUserObject, FBVideo, FBVideoClip, FBVideoClipImage, FBVideoGrabber, FBVideoIn, FBVideoMemory, FBVideoOut, FBView, FBVisualComponent, FBVisualContainer, FBWebView, and FBWidgetHolder.

def BeginChange ( )

Python Docstring:

BeginChange( (FBPlug)arg1) -> bool 

C++ Signature:

bool BeginChange() 

Begins a change on multiple plugs.

Returns:
A boolean indicating success (True) or failure (False).
def ClassName ( )

Python Docstring:

ClassName( (FBPlug)arg1) -> str 

C++ Signature:

const char * ClassName() 

internal System vars.

Reimplemented in FBComponent.

def ConnectDst ( )

Python Docstring:

ConnectDst( (FBPlug)arg1, (FBPlug)arg2 [, (FBConnectionType)arg3]) -> bool 

C++ Signature:

bool ConnectDst(FBPlug * pDst, FBConnectionType pConnectionType = kFBConnectionTypeNone) 

Add a destination connection.

Parameters:
pDst Destination plug.
pConnectionType Type of connection, taken from FBConnectionType. Default value should work in all cases.
Returns:
A boolean indicating success (True) or failure (False)
def ConnectDstAt ( )

Python Docstring:

ConnectDstAt( (FBPlug)arg1, (object)arg2, (FBPlug)arg3 [, (FBConnectionType)arg4]) -> bool 

C++ Signature:

bool ConnectDstAt(int pSrc_DstIndex, FBPlug * pDst, FBConnectionType pConnectionType = kFBConnectionTypeNone) 

Add a destination connection.

Parameters:
pSrc_DstIndex Index that tells where to add this destination connection in the source's connection list. if index is out of bound, and this destination connection will be appended at the end.
pDst Destination plug.
pConnectionType Type of connection, taken from FBConnectionType. Default value should work in all cases.
Returns:
A boolean indicating success (True) or failure (False).
def ConnectSrc ( )

Python Docstring:

ConnectSrc( (FBPlug)arg1, (FBPlug)arg2 [, (FBConnectionType)arg3]) -> bool 

C++ Signature:

bool ConnectSrc(FBPlug * pSrc, FBConnectionType pConnectionType = kFBConnectionTypeNone) 

Add a source connection.

Parameters:
pSrc Source plug.
pConnectionType Type of connection, taken from FBConnectionType. Default value should work in all cases.
Returns:
A boolean indicating success (True) or failure (False).
def ConnectSrcAt ( )

Python Docstring:

ConnectSrcAt( (FBPlug)arg1, (object)arg2, (FBPlug)arg3 [, (FBConnectionType)arg4]) -> bool 

C++ Signature:

bool ConnectSrcAt(int pDst_SrcIndex, FBPlug * pSrc, FBConnectionType pConnectionType = kFBConnectionTypeNone) 

Add a source connection.

Parameters:
pDst_SrcIndex Index that tells where to add this source connection in the destination's connection list. if index is out of bound, and this source connection will be appended at the end.
pSrc Source plug.
pConnectionType Type of connection, taken from FBConnectionType. Default value should work in all cases.
Returns:
A boolean indicating success (True) or failure (False).
def DisconnectAllDst ( )

Python Docstring:

DisconnectAllDst( (FBPlug)arg1) -> None 

C++ Signature:

void DisconnectAllDst() 

Remove all destination connections.

def DisconnectAllSrc ( )

Python Docstring:

DisconnectAllSrc( (FBPlug)arg1) -> None 

C++ Signature:

void DisconnectAllSrc() 

Remove all source connections.

def DisconnectDst ( )

Python Docstring:

DisconnectDst( (FBPlug)arg1, (FBPlug)arg2) -> bool 

C++ Signature:

bool DisconnectDst(FBPlug * pDst) 

Remove a destination connection.

Parameters:
pDst Destination plug.
Returns:
A boolean indicating success (True) or failure (False).
def DisconnectDstAt ( )

Python Docstring:

DisconnectDstAt( (FBPlug)arg1, (object)arg2) -> bool 

C++ Signature:

bool DisconnectDstAt(int pIndex) 

Remove a destination connection at a specified index.

Parameters:
pIndex Destination plug index.
Returns:
A boolean indicating success (True) or failure (False).
def DisconnectSrc ( )

Python Docstring:

DisconnectSrc( (FBPlug)arg1, (FBPlug)arg2) -> bool 

C++ Signature:

bool DisconnectSrc(FBPlug * pSrc) 

Remove a source connection.

Parameters:
pSrc Source plug.
Returns:
A boolean indicating success (True) or failure (False).
def DisconnectSrcAt ( )

Python Docstring:

DisconnectSrcAt( (FBPlug)arg1, (object)arg2) -> bool 

C++ Signature:

bool DisconnectSrcAt(int pIndex) 

Remove a source connection at a specified index.

Parameters:
pIndex Source plug index.
Returns:
A boolean indicating success (True) or failure (False).
def EndChange ( )

Python Docstring:

EndChange( (FBPlug)arg1) -> None 

C++ Signature:

void EndChange() 

Ends a change on multiple plugs.

def GetDst ( )

Python Docstring:

GetDst( (FBPlug)arg1, (object)arg2) -> object 

C++ Signature:

FBPlug * GetDst(int pIndex) 

Get a destination connection's plug at specified index.

Parameters:
pIndex Index of the destination connection's plug.
Returns:
Destination plug at specified index.
def GetDstCount ( )

Python Docstring:

GetDstCount( (FBPlug)arg1) -> int 

C++ Signature:

int GetDstCount() 

Get destination connection count.

Returns:
Total destinations connections count.
def GetDstType ( )

Python Docstring:

GetDstType( (FBPlug)arg1, (object)arg2) -> FBConnectionType 

C++ Signature:

FBConnectionType GetDstType(int pIndex) 

Get a destination connection's type at specified index.

Parameters:
pIndex Index of the destination connection's type.
Returns:
Destination connection's type at specified index.
def GetOwned ( )

Python Docstring:

GetOwned( (FBPlug)arg1, (object)arg2) -> object 

C++ Signature:

FBPlug * GetOwned(int pIndex) 

Get the owned plug at specified index.

Parameters:
pIndex Index of the owned plug to get.
Returns:
The owned plug at specified index.
def GetOwnedCount ( )

Python Docstring:

GetOwnedCount( (FBPlug)arg1) -> int 

C++ Signature:

int GetOwnedCount() 

Get the owned plug count.

Returns:
The owned plug count.
def GetOwner ( )

Python Docstring:

GetOwner( (FBPlug)arg1) -> object 

C++ Signature:

FBPlug * GetOwner() 

Get the owner of this plug. Very useful for properties since they are plugs too.

Returns:
The owner of this plug.
def GetSrc ( )

Python Docstring:

GetSrc( (FBPlug)arg1, (object)arg2) -> object 

C++ Signature:

FBPlug * GetSrc(int pIndex) 

Get a source connection's plug at specified index.

Parameters:
pIndex Index of the source connection's plug.
Returns:
Source plug at specified index.
def GetSrcCount ( )

Python Docstring:

GetSrcCount( (FBPlug)arg1) -> int 

C++ Signature:

int GetSrcCount() 

Get source connection count.

Returns:
Total sources connections count.
def GetSrcType ( )

Python Docstring:

GetSrcType( (FBPlug)arg1, (object)arg2) -> FBConnectionType 

C++ Signature:

FBConnectionType GetSrcType(int pIndex) 

Get a source connection's type at specified index.

Parameters:
pIndex Index of the source connection's type.
Returns:
Source connection's type at specified index.
def Is ( )

Python Docstring:

Is( (FBPlug)arg1, (object)arg2) -> bool 

C++ Signature:

bool Is(int pTypeId) 

Is( int pTypeId )

Parameters:
pTypeId Type Identification.
Returns:
True if Plug is a Instance of pTypeId.

Reimplemented in FBComponent.

def IsSDKComponent ( )

Python Docstring:

IsSDKComponent( (FBPlug)arg1) -> bool 

C++ Signature:

bool IsSDKComponent() 

Return whether or not item is an SDK component.

def MoveSrcAt ( )

Python Docstring:

MoveSrcAt( (FBPlug)arg1, (object)arg2, (object)arg3) -> bool

MoveSrcAt( (FBPlug)arg1, (FBPlug)arg2, (FBPlug)arg3) -> bool 

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

bool MoveSrcAt(int pIndex, int pAtIndex)
bool MoveSrcAt(FBPlug * pSrc, FBPlug * pAtSrc)
def ReplaceDstAt ( )

Python Docstring:

ReplaceDstAt( (FBPlug)arg1, (object)arg2, (FBPlug)arg3) -> bool 

C++ Signature:

bool ReplaceDstAt(int pIndex, FBPlug * pDst) 

Replace a destination connection at a specified index.

Parameters:
pIndex Destination plug index.
pDst Plug that will replace the other at index.
Returns:
A boolean indicating success (True) or failure (False).
def ReplaceSrcAt ( )

Python Docstring:

ReplaceSrcAt( (FBPlug)arg1, (object)arg2, (FBPlug)arg3) -> bool 

C++ Signature:

bool ReplaceSrcAt(int pIndex, FBPlug * pSrc) 

Replace a source connection at a specified index.

Parameters:
pIndex Source plug index.
pSrc Plug that will replace the other at index.
Returns:
A boolean indicating success (True) or failure (False).
def SwapSrc ( )

Python Docstring:

SwapSrc( (FBPlug)arg1, (object)arg2, (object)arg3) -> bool 

C++ Signature:

bool SwapSrc(int pIndexA, int pIndexB) 

Swap source connection at index A with source connection at index B.

Parameters:
pIndexA Plug index.
pIndexB Other plug index.
Returns:
A boolean indicating success (True) or failure (False).
def SetSelfModified ( )

Python Docstring:

SetSelfModified( (FBPlug)arg1, (FBPlugModificationFlag)arg2, (object)arg3) -> None 

C++ Signature:

void SetSelfModified(FBPlugModificationFlag pFlag, bool pBool) 

Set the plug's self modification flag.

Parameters:
pFlag bitwise AND of self modification flags.
pBool true if self changed.
def GetSelfModified ( )

Python Docstring:

GetSelfModified( (FBPlug)arg1, (FBPlugModificationFlag)arg2) -> bool 

C++ Signature:

bool GetSelfModified(FBPlugModificationFlag pFlag) 

Tell if the plug's self has changed.

Parameters:
pFlag bitwise AND of self modification flags.
Returns:
true if self changed
def SetContentModified ( )

Python Docstring:

SetContentModified( (FBPlug)arg1, (FBPlugModificationFlag)arg2, (object)arg3) -> None 

C++ Signature:

void SetContentModified(FBPlugModificationFlag pFlag, bool pBool) 

Set the plug's owned property/object's modification flag.

Parameters:
pFlag bitwise AND of content modification flags.
pBool true if content has modification.
def GetContentModified ( )

Python Docstring:

GetContentModified( (FBPlug)arg1, (FBPlugModificationFlag)arg2) -> bool 

C++ Signature:

bool GetContentModified(FBPlugModificationFlag pFlag) 

Tell if the plug's content has changed.

Parameters:
pFlag bitwise AND of content modification flags.
Returns:
true if content connection changed.
def GetPlugConnectionModifiedList ( )

Python Docstring:

GetPlugConnectionModifiedList( (FBPlug)arg1, (FBPlugList)arg2, (FBPlugModificationFlag)arg3, (object)arg4) -> int 

C++ Signature:

int GetPlugConnectionModifiedList(FBArrayTemplate & pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove) 

Get plug's modified src/dst property/object connection added/removed List.

Parameters:
pPlugList plug list to fill up.
pConnectionModificatonFlag Src/Dst Property/Object connection modification flag.
pAddRemove Ask for the added list if true, removed list if false.
Returns:
count of list;
def RevertModification ( )

Python Docstring:

RevertModification( (FBPlug)arg1 [, (FBPlugModificationFlag)arg2]) -> bool 

C++ Signature:

bool RevertModification(FBPlugModificationFlag pFlag = kFBAllModifiedMask) 

Revert the plug's modification to original status.

Parameters:
pFlag the type of modification to be reverted.
Returns:
true if revert successfully.
def __init__ ( )

Python Docstring:

Raises an exception
This class cannot be instantiated from Python 

C++ Signature:

 FBPlug(HIObject pObject) 

! Constructor Internal use only. User code shouldn't instantiate FBPlug directly.

Reimplemented from FBPythonWrapper.

Reimplemented in FBBoxLayout, FBGridLayout, FBHBoxLayout, FBTabControl, FBVBoxLayout, FBActionManager, FBActor, FBActorFace, FBAnimationLayer, FBAnimationNode, FBApplication, FBArrowButton, FBAssetFile, FBAssetFolder, FBAssetItem, FBAssetMng, FBAudioClip, FBAudioIn, FBAudioOut, FBBox, FBBoxPlaceHolder, FBBrowsingProperty, FBButton, FBCamera, FBCameraStereo, FBCameraSwitcher, FBCharacter, FBCharacterExtension, FBCharacterFace, FBCharacterMarkerSet, FBCharacterPose, FBCharacterSolver, FBCluster, FBComponent, FBConstraint, FBConstraintManager, FBConstraintRelation, FBConstraintSolver, FBControlSet, FBDeck, FBDeformer, FBDeformerPointCache, FBDevice, FBDeviceInstrument, FBDeviceOptical, FBDeviceOpticalMarker, FBEdit, FBEditColor, FBEditNumber, FBEditProperty, FBEditPropertyModern, FBEditTimeCode, FBEditVector, FBEvaluateManager, FBFCurve, FBFCurveEditor, FBFbxOptions, FBFileMonitoringManager, FBFileReference, FBFilter, FBFolder, FBGenericMenu, FBGenericMenuItem, FBGeometry, FBGlobalLight, FBGroup, FBHUD, FBHUDBloopSlateElement, FBHUDElement, FBHUDFlashElement, FBHUDRectElement, FBHUDTextElement, FBHUDTextureElement, FBHUDTimelineElement, FBHandle, FBImage, FBImageContainer, FBKeyControl, FBKeyingGroup, FBLabel, FBLayeredTexture, FBLayout, FBLayoutRegion, FBLight, FBList, FBLogger, FBManipulator, FBMarkerSet, FBMaterial, FBMemo, FBMenuManager, FBMesh, FBModel, FBModelCube, FBModelMarker, FBModelMarkerOptical, FBModelNull, FBModelOptical, FBModelOpticalAdvanced, FBModelPath3D, FBModelPlaceHolder, FBModelPlane, FBModelRoot, FBModelSkeleton, FBModelTemplate, FBModelVertexData, FBMotionClip, FBNamespace, FBNote, FBNurbs, FBObjectPose, FBOpticalGap, FBOpticalSegment, FBPatch, FBPhysicalProperties, FBPlayerControl, FBPlotPopup, FBPointCacheFile, FBPointCacheManager, FBPopup, FBPose, FBProfiler, FBProgress, FBProperty, FBPropertyAction, FBPropertyAnimatable, FBPropertyAnimatableAction, FBPropertyAnimatableBool, FBPropertyAnimatableColor, FBPropertyAnimatableColorAndAlpha, FBPropertyAnimatableDouble, FBPropertyAnimatableEnum, FBPropertyAnimatableInt, FBPropertyAnimatableInt64, FBPropertyAnimatableTime, FBPropertyAnimatableTimeCode, FBPropertyAnimatableUInt64, FBPropertyAnimatableVector2d, FBPropertyAnimatableVector3d, FBPropertyAnimatableVector4d, FBPropertyBool, FBPropertyColor, FBPropertyColorAndAlpha, FBPropertyComponent, FBPropertyConnectionEditor, FBPropertyDouble, FBPropertyEnum, FBPropertyFloat, FBPropertyInt, FBPropertyList, FBPropertyListActor, FBPropertyListActorFace, FBPropertyListAudioClip, FBPropertyListAudioIn, FBPropertyListAudioOut, FBPropertyListBox, FBPropertyListCamera, FBPropertyListCharacter, FBPropertyListCharacterExtension, FBPropertyListCharacterFace, FBPropertyListCharacterMarkerSet, FBPropertyListCharacterPose, FBPropertyListComponent, FBPropertyListConstraint, FBPropertyListConstraintSolver, FBPropertyListControlSet, FBPropertyListDeck, FBPropertyListDeformer, FBPropertyListDevice, FBPropertyListFileReference, FBPropertyListFolder, FBPropertyListGroup, FBPropertyListHUD, FBPropertyListHUDElement, FBPropertyListHandle, FBPropertyListKeyingGroup, FBPropertyListLight, FBPropertyListMarkerSet, FBPropertyListMaterial, FBPropertyListModel, FBPropertyListModelOptical, FBPropertyListModelSkeleton, FBPropertyListMotionClip, FBPropertyListNamespace, FBPropertyListNote, FBPropertyListObject, FBPropertyListObjectPose, FBPropertyListPhysicalProperties, FBPropertyListPivot, FBPropertyListPose, FBPropertyListRendererCallback, FBPropertyListSet, FBPropertyListShader, FBPropertyListStoryClip, FBPropertyListStoryDetails, FBPropertyListStoryFolder, FBPropertyListStorySubTrack, FBPropertyListStoryTrack, FBPropertyListTake, FBPropertyListTexture, FBPropertyListTreeNode, FBPropertyListUserObject, FBPropertyListVideoClip, FBPropertyListVideoIn, FBPropertyListVideoOut, FBPropertyString, FBPropertyStringList, FBPropertyTime, FBPropertyTimeCode, FBPropertyVector2d, FBPropertyVector3d, FBPropertyVector4d, FBPropertyViewManager, FBReferenceTime, FBRenderer, FBRendererCallback, FBRigidBody, FBScene, FBScrollBox, FBSet, FBShader, FBShaderLighted, FBShaderShadowLive, FBSlider, FBSpread, FBSpreadCell, FBSpreadColumn, FBSpreadPart, FBSpreadRow, FBStory, FBStoryClip, FBStoryFolder, FBStoryTrack, FBSurface, FBSystem, FBTabPanel, FBTake, FBTexture, FBThermometer, FBTimeWarpManager, FBTool, FBTree, FBTreeNode, FBUserObject, FBVideo, FBVideoClip, FBVideoClipImage, FBVideoGrabber, FBVideoIn, FBVideoMemory, FBVideoOut, FBView, FBVisualComponent, FBVisualContainer, FBWebView, and FBWidgetHolder.

def PrintClassDefinitions ( )

Python Docstring:

staticmethod(function) -> method

Convert a function to be a static method.

A static method does not receive an implicit first argument.
To declare a static method, use this idiom:

     class C:
     def f(arg1, arg2, ...): ...
     f = staticmethod(f)

It can be called either on the class (e.g. C.f()) or on an instance
(e.g. C().f()).  The instance is ignored except for its class.

Static methods in Python are similar to those found in Java or C++.
For a more advanced concept, see the classmethod builtin. 

C++ Signature:

void PrintClassDefinitions() 

Print out internal Class (ID) Definition table. For internal debug purpose only.


Member Data Documentation