FBPropertyAnimatableEnum Class Reference
 
 
 
FBPropertyAnimatableEnum Class Reference

#include <mobu-python-api.h>

Inheritance diagram for FBPropertyAnimatableEnum:
FBPropertyAnimatable FBProperty FBPlug FBPythonWrapper

Public Member Functions

def  __reduce__ ()
def  __str__ ()
def  __repr__ ()
def  __init__ ()
def  GetDataTypeName ()
def  GetAnimationNode ()
def  GetBox ()
def  IsAnimated ()
def  IsFocused ()
def  OriIsAnimated ()
def  Key ()
def  KeyAt ()
def  KeyRemoveAt ()
def  SetAnimated ()
def  SetFocus ()
def  AllowsMuting ()
def  HasSomethingMuted ()
def  IsMuted ()
def  IsMemberMuted ()
def  SetMuted ()
def  SetMemberMuted ()
def  GetEnumStringList ()
def  GetName ()
def  SetName ()
def  GetPropertyType ()
def  ModifyPropertyFlag ()
def  GetPropertyFlags ()
def  GetPropertyFlag ()
def  GetPropertyTypeName ()
def  AsString ()
def  SetString ()
def  OriValueAsString ()
def  IsAnimatable ()
def  IsInternal ()
def  IsList ()
def  IsObjectList ()
def  IsReadOnly ()
def  IsMinClamp ()
def  IsMaxClamp ()
def  IsTextureConnectableProperty ()
def  IsReferenceProperty ()
def  IsUserProperty ()
def  SetMin ()
def  SetMax ()
def  GetMin ()
def  GetMax ()
def  AllowsLocking ()
def  HasSomethingLocked ()
def  IsLocked ()
def  IsMemberLocked ()
def  SetLocked ()
def  SetMemberLocked ()
def  GetSubMemberCount ()
def  EnumList ()
def  NotifyEnumStringListChanged ()
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  PrintClassDefinitions ()

Public Attributes

object  Data
FBString  Name
object  OnUnbind

Member Function Documentation

def __reduce__ ( )
def __str__ ( )

Python Docstring:

__str__( (FBPropertyAnimatableEnum)arg1) -> object 
def __repr__ ( )

Python Docstring:

__repr__( (FBPropertyAnimatableEnum)arg1) -> str 
def __init__ ( )

Python Docstring:

Raises an exception
This class cannot be instantiated from Python 

Reimplemented from FBPropertyAnimatable.

def GetDataTypeName ( ) [inherited]

Python Docstring:

GetDataTypeName( (FBPropertyAnimatable)arg1) -> str 

C++ Signature:

const char * GetDataTypeName() 

Get the property datatype name.

Returns:
Datatype of property as a character string.
GetAnimationNode ( ) [inherited]

Python Docstring:

GetAnimationNode( (FBPropertyAnimatable)arg1) -> object 

C++ Signature:

FBAnimationNode * GetAnimationNode(FBTake * pTake = NULL) 

Get the animation node for the property.

Parameters:
pTake to get the animation node from.
Returns:
Animation node for property. NULL is returned if property is not animated.
In Python, None is returned if property is not animated.
def GetBox ( ) [inherited]

Python Docstring:

GetBox( (FBPropertyAnimatable)arg1) -> object 

C++ Signature:

FBBox * GetBox() 

Get the owner box.

Returns:
Handle to the owning box (i.e. model).
def IsAnimated ( ) [inherited]

Python Docstring:

IsAnimated( (FBPropertyAnimatable)arg1) -> bool 

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

bool IsAnimated()
bool IsAnimated()
def IsFocused ( ) [inherited]

Python Docstring:

IsFocused( (FBPropertyAnimatable)arg1) -> bool 

C++ Signature:

bool IsFocused() 

Is the property focused (keyable).

Returns:
Current focus (keyable) state for the property.
def OriIsAnimated ( ) [inherited]

Python Docstring:

OriIsAnimated( (FBPropertyAnimatable)arg1) -> bool 

C++ Signature:

bool OriIsAnimated() 

Get the property original animated flag status (before any modification)

def Key ( ) [inherited]

Python Docstring:

Key( (FBPropertyAnimatable)arg1) -> None 

C++ Signature:

void Key() 

Key the property.

def KeyAt ( ) [inherited]

Python Docstring:

KeyAt( (FBPropertyAnimatable)arg1, (FBTime)arg2) -> None 

C++ Signature:

void KeyAt(FBTime pTime) 

Key the property at time (t).

Parameters:
pTime Time at which to insert the key.
def KeyRemoveAt ( ) [inherited]

Python Docstring:

KeyRemoveAt( (FBPropertyAnimatable)arg1, (FBTime)arg2) -> None 

C++ Signature:

void KeyRemoveAt(FBTime pTime) 

Remove the key at time (t).

Parameters:
pTime Time at which to insert the key.
def SetAnimated ( ) [inherited]

Python Docstring:

SetAnimated( (FBPropertyAnimatable)arg1, (object)arg2) -> None 

C++ Signature:

void SetAnimated(bool pState) 

Set the animation state of the property.

Parameters:
pState State of animation for property, true to animate, false to remove curves.
def SetFocus ( ) [inherited]

Python Docstring:

SetFocus( (FBPropertyAnimatable)arg1, (object)arg2) -> None 

C++ Signature:

void SetFocus(bool pState) 

Set the property's focus (keyable) state.

Parameters:
pState Focus (keyable) state to set for the property.
def AllowsMuting ( ) [inherited]

Python Docstring:

AllowsMuting( (FBPropertyAnimatable)arg1) -> bool 

C++ Signature:

bool AllowsMuting() 

AllowsMuting.

Returns:
true if property can be muted
def HasSomethingMuted ( ) [inherited]

Python Docstring:

HasSomethingMuted( (FBPropertyAnimatable)arg1) -> bool 

C++ Signature:

bool HasSomethingMuted() 

HasSomethingMuted.

Returns:
true if property or any of its members is muted
def IsMuted ( ) [inherited]

Python Docstring:

IsMuted( (FBPropertyAnimatable)arg1) -> bool 

C++ Signature:

bool IsMuted() 

IsMuted.

Returns:
true if property is muted
def IsMemberMuted ( ) [inherited]

Python Docstring:

IsMemberMuted( (FBPropertyAnimatable)arg1, (object)arg2) -> bool 

C++ Signature:

bool IsMemberMuted(int pIndex) 

IsMemberMuted.

Parameters:
pIndex Index of the sub-member of the property to check.
Returns:
true if property sub-member is muted
def SetMuted ( ) [inherited]

Python Docstring:

SetMuted( (FBPropertyAnimatable)arg1, (object)arg2) -> None 

C++ Signature:

void SetMuted(bool pMuted) 

SetMuted.

Parameters:
pMuted True if the property is to be muted, false if it is to be unmuted.
def SetMemberMuted ( ) [inherited]

Python Docstring:

SetMemberMuted( (FBPropertyAnimatable)arg1, (object)arg2, (object)arg3) -> None 

C++ Signature:

void SetMemberMuted(int pIndex, bool pMuted) 

SetMemberMuted.

Parameters:
pIndex Index of the sub-member of the property to mute or unmute.
pMuted True if the sub-member is to be muted, false if it is to be unmuted.
def GetEnumStringList ( ) [inherited]

Python Docstring:

GetEnumStringList( (FBProperty)arg1 [, (object)arg2]) -> FBStringList 

C++ Signature:

FBStringList * GetEnumStringList(bool pCreateIt = false) 

String list for enum properties.

Parameters:
pCreateIt Create a new list if necessary.
Returns:
the pointer to the string list..
def GetName ( ) [inherited]

Python Docstring:

GetName( (FBProperty)arg1) -> str 

C++ Signature:

const char * GetName() 

Get the property's name.

Returns:
The property's name.
def SetName ( ) [inherited]

Python Docstring:

SetName( (FBProperty)arg1, (str)arg2) -> None 

C++ Signature:

void SetName(const char * pName) 

Set the property's name.

Parameters:
pName New name for the property.
def GetPropertyType ( ) [inherited]

Python Docstring:

GetPropertyType( (FBProperty)arg1) -> FBPropertyType 

C++ Signature:

FBPropertyType GetPropertyType() 

Get the property's type.

Returns:
The property's type.
def ModifyPropertyFlag ( ) [inherited]

Python Docstring:

ModifyPropertyFlag( (FBProperty)arg1, (FBPropertyFlag)arg2, (object)arg3) -> None 

C++ Signature:

void ModifyPropertyFlag(FBPropertyFlag pFlag, bool pValue) 

ModifyPropertyFlag.

Parameters:
pFlag The flag to switch to True or False.
pValue The value to set about this flag.
Warning:
Flags are not saved into or read from a FBX file.
def GetPropertyFlags ( ) [inherited]

Python Docstring:

GetPropertyFlags( (FBProperty)arg1) -> int 

C++ Signature:

FBPropertyFlag GetPropertyFlags() 

GetPropertyFlags.

Returns:
Return all flags at once.
def GetPropertyFlag ( ) [inherited]

Python Docstring:

GetPropertyFlag( (FBProperty)arg1, (FBPropertyFlag)arg2) -> bool 

C++ Signature:

bool GetPropertyFlag(FBPropertyFlag pFlag) 

GetPropertyFlag.

Parameters:
pFlag Flag to test if it is True or False.
Returns:
If the flag is True, the function returns True and vice-versa.
Warning:
Flags are not saved into or read from a FBX file.
def GetPropertyTypeName ( ) [inherited]

Python Docstring:

GetPropertyTypeName( (FBProperty)arg1) -> str 

C++ Signature:

const char * GetPropertyTypeName() 

Get the property's type name.

Returns:
The property's type name.
def AsString ( ) [inherited]

Python Docstring:

AsString( (FBProperty)arg1 [, (FBDataAsStringFlag)arg2]) -> str 

C++ Signature:

const char * AsString(FBDataAsStringFlag pFlag = kFBDataAsStringUI) 

Get the property value as a string.

Parameters:
pFlag Indicates the returned string to be used for UI or storage. It defaults to kFBDataAsStringUI.
Returns:
The string version of the property.
def SetString ( ) [inherited]

Python Docstring:

SetString( (FBProperty)arg1, (str)arg2) -> bool 

C++ Signature:

bool SetString(const char * pString) 

Set the property value from a string.

Parameters:
pString String to set property value from, with format same as AsString(kFBDataAsStringPersistence)
Returns:
True if it was possible.
def OriValueAsString ( ) [inherited]

Python Docstring:

OriValueAsString( (FBProperty)arg1) -> str 

C++ Signature:

const char * OriValueAsString() 

Get the property original value (before any modification) as string.

Returns:
returns the original value of the property in string with format same as AsString(kDataAsStringPersistence)
def IsAnimatable ( ) [inherited]

Python Docstring:

IsAnimatable( (FBProperty)arg1) -> bool 

C++ Signature:

bool IsAnimatable() 
def IsInternal ( ) [inherited]

Python Docstring:

IsInternal( (FBProperty)arg1) -> bool 

C++ Signature:

bool IsInternal() 
def IsList ( ) [inherited]

Python Docstring:

IsList( (FBProperty)arg1) -> bool 

C++ Signature:

bool IsList() 

Verify if property is of this type.

Returns:
true if property is of type.
def IsObjectList ( ) [inherited]

Python Docstring:

IsObjectList( (FBProperty)arg1) -> bool 

C++ Signature:

bool IsObjectList() 

Indicate if is an instance of FBPropertyListObject.

Warning:
A FBPropertyListObject will also return true on a call to 'IsList()'.
def IsReadOnly ( ) [inherited]

Python Docstring:

IsReadOnly( (FBProperty)arg1) -> bool 

C++ Signature:

bool IsReadOnly() 

Is property read-only?

Returns:
true if property is read-only.
def IsMinClamp ( ) [inherited]

Python Docstring:

IsMinClamp( (FBProperty)arg1) -> bool 

C++ Signature:

bool IsMinClamp() 

Indicate if minimum value clamping will be applied on user input value.

Returns:
true if property the value will be clamped to a minimum value.
def IsMaxClamp ( ) [inherited]

Python Docstring:

IsMaxClamp( (FBProperty)arg1) -> bool 

C++ Signature:

bool IsMaxClamp() 

Indicate if maximum value clamping will be applied on user input value.

Returns:
true if property the value will be clamped to a maximum value.
def IsTextureConnectableProperty ( ) [inherited]

Python Docstring:

IsTextureConnectableProperty( (FBProperty)arg1) -> bool 

C++ Signature:

bool IsTextureConnectableProperty() 
def IsReferenceProperty ( ) [inherited]

Python Docstring:

IsReferenceProperty( (FBProperty)arg1) -> bool 

C++ Signature:

bool IsReferenceProperty() 
def IsUserProperty ( ) [inherited]

Python Docstring:

IsUserProperty( (FBProperty)arg1) -> bool 

C++ Signature:

bool IsUserProperty() 
def SetMin ( ) [inherited]

Python Docstring:

SetMin( (FBProperty)arg1, (object)arg2 [, (object)arg3]) -> None 

C++ Signature:

void SetMin(double pMin, bool pForceMinClamp = false) 

SetMin.

Parameters:
pMin Minimum value of the property.
pForceMinClamp Force clamping to minimum value of the property.
def SetMax ( ) [inherited]

Python Docstring:

SetMax( (FBProperty)arg1, (object)arg2 [, (object)arg3]) -> None 

C++ Signature:

void SetMax(double pMax, bool pForceMaxClamp = false) 

SetMax.

Parameters:
pMax Maximum value of the property.
pForceMaxClamp Force clamping to maximum value of the property.
def GetMin ( ) [inherited]

Python Docstring:

GetMin( (FBProperty)arg1) -> float 

C++ Signature:

double GetMin() 

GetMin.

Returns:
Minimum value for the property.
def GetMax ( ) [inherited]

Python Docstring:

GetMax( (FBProperty)arg1) -> float 

C++ Signature:

double GetMax() 

GetMax.

Returns:
Maximum value for the property.
def AllowsLocking ( ) [inherited]

Python Docstring:

AllowsLocking( (FBProperty)arg1) -> bool 

C++ Signature:

bool AllowsLocking() 

AllowsLocking.

Returns:
true if property can be locked
def HasSomethingLocked ( ) [inherited]

Python Docstring:

HasSomethingLocked( (FBProperty)arg1) -> bool 

C++ Signature:

bool HasSomethingLocked() 

HasSomethingLocked.

Returns:
true if property or any of its members is locked
def IsLocked ( ) [inherited]

Python Docstring:

IsLocked( (FBProperty)arg1) -> bool 

C++ Signature:

bool IsLocked() 

IsLocked.

Returns:
true if property is locked
def IsMemberLocked ( ) [inherited]

Python Docstring:

IsMemberLocked( (FBProperty)arg1, (object)arg2) -> bool 

C++ Signature:

bool IsMemberLocked(int pIndex) 

IsMemberLocked.

Parameters:
pIndex Index of the sub-member of the property to check.
Returns:
true if property sub-member is locked
def SetLocked ( ) [inherited]

Python Docstring:

SetLocked( (FBProperty)arg1, (object)arg2) -> None 

C++ Signature:

void SetLocked(bool pLocked) 

SetLocked.

Parameters:
pLocked True if the property is to be locked, false if it is to be unlocked.
def SetMemberLocked ( ) [inherited]

Python Docstring:

SetMemberLocked( (FBProperty)arg1, (object)arg2, (object)arg3) -> None 

C++ Signature:

void SetMemberLocked(int pIndex, bool pLocked) 

SetMemberLocked.

Parameters:
pIndex Index of the sub-member of the property to lock or unlock.
pLocked True if the sub-member is to be locked, false if it is to be unlocked.
def GetSubMemberCount ( ) [inherited]

Python Docstring:

GetSubMemberCount( (FBProperty)arg1) -> int 

C++ Signature:

int GetSubMemberCount() 

GetSubMemberCount.

Returns:
Number of sub-members.
def EnumList ( ) [inherited]

Python Docstring:

EnumList( (FBProperty)arg1, (object)arg2) -> str 

C++ Signature:

const char * EnumList(int pIndex) 

Return the string of an enum value.

Parameters:
pIndex Enum value to get string for.
Returns:
String value of enum specified by pIndex.
def NotifyEnumStringListChanged ( ) [inherited]

Python Docstring:

NotifyEnumStringListChanged( (FBProperty)arg1) -> None 

C++ Signature:

void NotifyEnumStringListChanged() 

Notify system that the enum list was modified.

def BeginChange ( ) [inherited]

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 ( ) [inherited]

Python Docstring:

ClassName( (FBPlug)arg1) -> str 

C++ Signature:

const char * ClassName() 

internal System vars.

Reimplemented in FBComponent.

def ConnectDst ( ) [inherited]

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 ( ) [inherited]

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 ( ) [inherited]

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 ( ) [inherited]

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 ( ) [inherited]

Python Docstring:

DisconnectAllDst( (FBPlug)arg1) -> None 

C++ Signature:

void DisconnectAllDst() 

Remove all destination connections.

def DisconnectAllSrc ( ) [inherited]

Python Docstring:

DisconnectAllSrc( (FBPlug)arg1) -> None 

C++ Signature:

void DisconnectAllSrc() 

Remove all source connections.

def DisconnectDst ( ) [inherited]

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 ( ) [inherited]

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 ( ) [inherited]

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 ( ) [inherited]

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 ( ) [inherited]

Python Docstring:

EndChange( (FBPlug)arg1) -> None 

C++ Signature:

void EndChange() 

Ends a change on multiple plugs.

def GetDst ( ) [inherited]

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 ( ) [inherited]

Python Docstring:

GetDstCount( (FBPlug)arg1) -> int 

C++ Signature:

int GetDstCount() 

Get destination connection count.

Returns:
Total destinations connections count.
def GetDstType ( ) [inherited]

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 ( ) [inherited]

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 ( ) [inherited]

Python Docstring:

GetOwnedCount( (FBPlug)arg1) -> int 

C++ Signature:

int GetOwnedCount() 

Get the owned plug count.

Returns:
The owned plug count.
def GetOwner ( ) [inherited]

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 ( ) [inherited]

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 ( ) [inherited]

Python Docstring:

GetSrcCount( (FBPlug)arg1) -> int 

C++ Signature:

int GetSrcCount() 

Get source connection count.

Returns:
Total sources connections count.
def GetSrcType ( ) [inherited]

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 ( ) [inherited]

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 ( ) [inherited]

Python Docstring:

IsSDKComponent( (FBPlug)arg1) -> bool 

C++ Signature:

bool IsSDKComponent() 

Return whether or not item is an SDK component.

def MoveSrcAt ( ) [inherited]

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 ( ) [inherited]

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 ( ) [inherited]

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 ( ) [inherited]

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 ( ) [inherited]

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 ( ) [inherited]

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 ( ) [inherited]

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 ( ) [inherited]

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 ( ) [inherited]

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 ( ) [inherited]

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 PrintClassDefinitions ( ) [inherited]

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

object Data

Read Write Property: The property data value. Type of this depends on the subclass of FBPropertyAnimatable (ex: in a FBPropertyAnimatableInt, Data is of type int).

Reimplemented from FBPropertyAnimatable.

Name [inherited]

mName Property unique name.

Read Property: (str) The property's name.