FBPropertyStringList Class Reference
 
 
 
FBPropertyStringList Class Reference

#include <fbproperties.h>


Class Description

Property: StringList

Definition at line 964 of file fbproperties.h.

Inheritance diagram for FBPropertyStringList:
FBProperty FBPlug FBWrapperHolder

Public Member Functions

  FBPropertyStringList ()
  Constructor.
virtual  ~FBPropertyStringList ()
  Destructor.
FBPropertyStringList Init (FBComponent *pComponent, const char *pName)
  Property initialization function.
kReference  GetReferenceAt (int pIndex)
  Get the reference at pIndex.
void  SetReferenceAt (int pIndex, kReference pRef)
  Set reference at pIndex.
int  Find (kReference pRef)
  Find the index of a reference.
int  Find (const char *S)
  Find the index of a string.
virtual const char *  GetAt (int pIndex)
  Get the string stored at pIndex.
const char *  operator[] (int pIndex)
  [] operator overload.
void  Sort ()
  Sort list ascending.
int  GetCount ()
  Get the number of items in the list.
int  Remove (const char *S)
  Remove a string from the list.
virtual int  Add (const char *S, kReference pRef=0)
  Add a string to the list.
virtual void  Clear ()
  Clear the list (remove all the items).
virtual void  RemoveAt (int pIndex)
  Remove an entry at pIndex.
virtual int  IndexOf (const char *S)
  Get the index of a string.
virtual void  InsertAt (int pIndex, const char *S, kReference pRef=0)
  Insert an entry at pIndex.
virtual bool  SetAt (int pIndex, const char *pString)
  Set the string at pIndex.
virtual bool  IsList () override
  Is this class a list?
virtual const char *  AsString (FBDataAsStringFlag pFlag=kFBDataAsStringUI) override
  Get as string.
virtual bool  SetString (const char *pString) override
  Set string for list.
virtual FBPropertyType  GetPropertyType () override
  Get the property's type.
  IObject_Declare (K_IMPLEMENTATION)
  IObject_Declare Interface to IObject.
FBProperty InitInternal (KProperty *pProperty)
  Initialize internal pointer.
KProperty *  GetInternal () const
  Get property.
void *  GetValuePtr () const
  Get property value.
FBProperty CreateInternal (FBComponent *pParent, const char *pName, fbExternalGetSetHandler pGet=NULL, fbExternalGetSetHandler pSet=NULL)
  Creation of internal property.
FBProperty CreateTextureConnectable (FBComponent *pParent, const char *pName)
  Creation of user texture connect property.
void  SetInternal (KProperty *pInternal)
  Set internal property.
void  SetEnable (bool pValue)
  Set property enable status.
const char *  GetName ()
  Get the property's name.
void  SetName (const char *pName)
  Set the property's name.
const char *  GetPropertyTypeName ()
  Get the property's type name.
virtual KDataType *  GetDataType ()
  Get the property datatype pointer.
int  AsInt ()
  Get the property as an integer.
bool  SetInt (int pInt)
  Set the property from an integer.
const char *  OriValueAsString ()
  Get the property original value (before any modification) as string.
bool  IsAnimated () const
  Get the property animated flag status.
bool  OriIsAnimated () const
  Get the property original animated flag status (before any modification)
bool  IsMinClamp ()
  Indicate if minimum value clamping will be applied on user input value.
bool  IsMaxClamp ()
  Indicate if maximum value clamping will be applied on user input value.
bool  IsTemporaryProperty ()
  Indicate if a property was created on retrieve because it didn't exist.
bool  AcceptTemporaryProperty (const char *pEnumList[]=NULL, fbExternalGetSetHandler pGet=NULL, fbExternalGetSetHandler pSet=NULL)
  Accept a temporary property as a dynamic property.
bool  IsObjectList ()
  Indicate if is an instance of FBPropertyListObject.
virtual bool  IsReadOnly ()
  Is property read-only?
virtual const char *  EnumList (int pIndex)
  Return the string of an enum value.
FBStringList GetEnumStringList (bool pCreateIt=false)
  String list for enum properties.
void  NotifyEnumStringListChanged ()
  Notify system that the enum list was modified.
void  ModifyPropertyFlag (FBPropertyFlag pFlag, bool pValue)
  ModifyPropertyFlag.
FBPropertyFlag  GetPropertyFlags ()
  GetPropertyFlags.
bool  GetPropertyFlag (FBPropertyFlag pFlag)
  GetPropertyFlag.
void  SetMinMax (double pMin, double pMax, bool pForceMinClamp=false, bool pForceMaxClamp=false)
  SetMinMax.
void  SetMin (double pMin, bool pForceMinClamp=false)
  SetMin.
void  SetMax (double pMax, bool pForceMaxClamp=false)
  SetMax.
double  GetMin ()
  GetMin.
double  GetMax ()
  GetMax.
void *  GetParent ()
  Get the parent of the object.
virtual HIObject  GetHIObject () const
  Return an internal pointer.
virtual bool  SetHIObject (HIObject pObject, bool pSDKComponent)
  Assign component to an internal pointer.
bool  IsSDKComponent ()
  Return whether or not item is an SDK component.
bool  ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
  Add a source connection.
bool  ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
  Add a destination connection.
bool  ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
  Add a source connection.
bool  ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
  Add a destination connection.
bool  DisconnectDst (FBPlug *pDst)
  Remove a destination connection.
bool  DisconnectSrc (FBPlug *pSrc)
  Remove a source connection.
void  DisconnectAllSrc ()
  Remove all source connections.
void  DisconnectAllDst ()
  Remove all destination connections.
bool  DisconnectDstAt (int pIndex)
  Remove a destination connection at a specified index.
bool  DisconnectSrcAt (int pIndex)
  Remove a source connection at a specified index.
bool  ReplaceDstAt (int pIndex, FBPlug *pDst)
  Replace a destination connection at a specified index.
bool  ReplaceSrcAt (int pIndex, FBPlug *pSrc)
  Replace a source connection at a specified index.
bool  SwapSrc (int pIndexA, int pIndexB)
  Swap source connection at index A with source connection at index B.
bool  MoveSrcAt (int pIndex, int pAtIndex)
  Move source connection at pIndex to pAtIndex.
bool  MoveSrcAt (FBPlug *pSrc, FBPlug *pAtSrc)
  Move source connection pSrc to the position of pAtSrc.
int  GetSrcCount ()
  Get source connection count.
FBPlug GetSrc (int pIndex)
  Get a source connection's plug at specified index.
FBConnectionType  GetSrcType (int pIndex)
  Get a source connection's type at specified index.
int  GetDstCount ()
  Get destination connection count.
FBPlug GetDst (int pIndex)
  Get a destination connection's plug at specified index.
FBConnectionType  GetDstType (int pIndex)
  Get a destination connection's type at specified index.
bool  BeginChange ()
  Begins a change on multiple plugs.
void  EndChange ()
  Ends a change on multiple plugs.
void  SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
  Set the plug's self modification flag.
bool  GetSelfModified (FBPlugModificationFlag pFlag)
  Tell if the plug's self has changed.
void  SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
  Set the plug's owned property/object's modification flag.
bool  GetContentModified (FBPlugModificationFlag pFlag)
  Tell if the plug's content has changed.
int  GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
  Get plug's modified src/dst property/object connection added/removed List.
bool  RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
  Revert the plug's modification to original status.
void  SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
  Set the plug's status flag.
bool  GetStatusFlag (FBPlugStatusFlag pStatus) const
  Tell if the plug's status has changed.
FBPlug GetOwner ()
  Get the owner of this plug.
FBPlug GetOwned (int pIndex)
  Get the owned plug at specified index.
int  GetOwnedCount ()
  Get the owned plug count.
virtual const char *  ClassName ()
  internal System vars.
virtual bool  Is (int pTypeId)
  Is( int pTypeId )
virtual int  GetTypeId ()
  GetTypeId( int pTypeId )
virtual bool  PlugDataNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=NULL, void *pDataOld=NULL, int pDataSize=0)
  PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only.
virtual bool  PlugStateNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=NULL, void *pDataOld=NULL, int pDataSize=0)
  PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only.
virtual bool  PlugNotify (FBConnectionAction pAction, FBPlug *pThis, int pIndex, FBPlug *pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
  PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only.
  ICallback_Declare (K_IMPLEMENTATION)
FBScriptWrapper GetWrapper ()
  Return the wrapper interface of this FBObject.
void  AddWrapper (FBScriptWrapper *)
void  RemoveWrapper (FBScriptWrapper *)
virtual void  SetData (void *pData)
  Set the value of the property, passing the type as an argument.
virtual void  GetData (void *pData, int pSize, FBEvaluateInfo *pEvalInfo=NULL) const
  Get the value of a property.
virtual bool  IsAnimatable ()
bool  IsInternal () const
bool  IsUserProperty ()
bool  IsTextureConnectableProperty ()
bool  IsReferenceProperty ()
Interface for property locking mechanism.

Locking a property or any number of its channel(s) prevents the user from modifying animation on this property.

This means that the user can�t add, remove or edit any key on any layer of a locked property/channel. It also means that the user can�t change the current value of the property. However, a locked property allows existing animation to flow through. This means that the value of a locked property can change through time as its being driven by existing animation and/or constraints.

int  GetSubMemberCount () const
  GetSubMemberCount.
bool  AllowsLocking () const
  AllowsLocking.
bool  HasSomethingLocked () const
  HasSomethingLocked.
bool  IsLocked () const
  IsLocked.
bool  IsMemberLocked (int pIndex) const
  IsMemberLocked.
void  SetLocked (bool pLocked)
  SetLocked.
void  SetMemberLocked (int pIndex, bool pLocked)
  SetMemberLocked.

Static Public Member Functions

static void  PrintClassDefinitions ()
  Print out internal Class (ID) Definition table.

Public Attributes

bool  mAllocated
  Contain the Allocation State of the Component.

Static Public Attributes

static const char *  ClassGroupName
  ClassGroupName of the object.
static int  TypeInfo
  TypeInfo.

Protected Member Functions

virtual void  FBDelete ()
  Actual destructor for a FBPlug.

Static Protected Member Functions

static int  GetInternalClassId ()
  Internal class Id.

Protected Attributes

FBString  mName
  mName Property unique name.
void *  mParent
  mParent Parent of the property.
HIObject  mObject
  Handle on the Plug.
bool  mSDKComponent
  bool Plug is an SDK component.

Static Protected Attributes

static int  mGlobalTypeInfo
  Represente the Type Index.

Friends

K_DLLIMPORT friend int  __FBRegisterTypeInfo (int pInternalClassId)
  __FBRegisterTypeInfo For internal use only, Register the TypeInfo mapped to internal class id.

Constructor & Destructor Documentation

FBPropertyStringList::FBPropertyStringList ( )

Constructor.

virtual FBPropertyStringList::~FBPropertyStringList ( ) [virtual]

Destructor.


Member Function Documentation

FBPropertyStringList* FBPropertyStringList::Init ( FBComponent pComponent,
const char *  pName 
)

Property initialization function.

Parameters:
pComponent Owner component.
pName Name of FBPropertyStringList
Returns:
Pointer to this FBPropertyStringList
kReference FBPropertyStringList::GetReferenceAt ( int  pIndex )

Get the reference at pIndex.

Parameters:
pIndex Index to get reference at.
Returns:
Reference stored at pIndex.
void FBPropertyStringList::SetReferenceAt ( int  pIndex,
kReference  pRef 
)

Set reference at pIndex.

Parameters:
pIndex Index to set reference at.
pRef Reference to store.
int FBPropertyStringList::Find ( kReference  pRef )

Find the index of a reference.

Parameters:
pRef Reference to find in list.
Returns:
Index where reference is stored.
int FBPropertyStringList::Find ( const char *  S )

Find the index of a string.

Parameters:
S String to find in list.
Returns:
Index of string S.
virtual const char* FBPropertyStringList::GetAt ( int  pIndex ) [virtual]

Get the string stored at pIndex.

Parameters:
pIndex Index to access
Returns:
String stored at pIndex.
const char* FBPropertyStringList::operator[] ( int  pIndex )

[] operator overload.

Return the string stored at pIndex.

Parameters:
pIndex Index to access.
Returns:
String stored at pIndex.
void FBPropertyStringList::Sort ( )

Sort list ascending.

int FBPropertyStringList::GetCount ( )

Get the number of items in the list.

Returns:
Number of strings stored in the list.
int FBPropertyStringList::Remove ( const char *  S )

Remove a string from the list.

Parameters:
S String to remove from the list.
Returns:
Index where item was found.
virtual int FBPropertyStringList::Add ( const char *  S,
kReference  pRef = 0 
) [virtual]

Add a string to the list.

Parameters:
S String to add to list.
pRef Reference to stored with string (default = 0)
Returns:
Index where item was stored.
virtual void FBPropertyStringList::Clear ( ) [virtual]

Clear the list (remove all the items).

virtual void FBPropertyStringList::RemoveAt ( int  pIndex ) [virtual]

Remove an entry at pIndex.

Parameters:
pIndex Index where item is to be removed from.
virtual int FBPropertyStringList::IndexOf ( const char *  S ) [virtual]

Get the index of a string.

Parameters:
S String to look for.
Returns:
Index where string S was found.
virtual void FBPropertyStringList::InsertAt ( int  pIndex,
const char *  S,
kReference  pRef = 0 
) [virtual]

Insert an entry at pIndex.

Parameters:
pIndex Index where item is to be inserted.
S String to insert.
pRef Reference to store with string.
virtual bool FBPropertyStringList::SetAt ( int  pIndex,
const char *  pString 
) [virtual]

Set the string at pIndex.

Parameters:
pIndex Index where string is to be set.
pString String to set value at pIndex with.
Returns:
true if success.
virtual bool FBPropertyStringList::IsList ( ) [override, virtual]

Is this class a list?

Returns:
true (this class is a list).

Reimplemented from FBProperty.

virtual const char* FBPropertyStringList::AsString ( FBDataAsStringFlag  pFlag = kFBDataAsStringUI ) [override, virtual]

Get as string.

Parameters:
pFlag Specifies the purpose of returned string it defaults to kFBDataAsStringUI.
Returns:
String list.

Reimplemented from FBProperty.

virtual bool FBPropertyStringList::SetString ( const char *  pString ) [override, virtual]

Set string for list.

Parameters:
pString String to set for list, with format same as AsString(kFBDataAsStringPersistence)
Returns:
True if it was possible.

Reimplemented from FBProperty.

virtual FBPropertyType FBPropertyStringList::GetPropertyType ( ) [inline, override, virtual]

Get the property's type.

Returns:
The property's type.

Reimplemented from FBProperty.

Definition at line 1087 of file fbproperties.h.

{ return kFBPT_stringlist; }
FBProperty::IObject_Declare ( K_IMPLEMENTATION  ) [inherited]

IObject_Declare Interface to IObject.

Reimplemented from FBPlug.

FBProperty* FBProperty::InitInternal ( KProperty *  pProperty ) [inherited]

Initialize internal pointer.

KProperty* FBProperty::GetInternal ( ) const [inherited]
void* FBProperty::GetValuePtr ( ) const [inherited]

Get property value.

FBProperty* FBProperty::CreateInternal ( FBComponent pParent,
const char *  pName,
fbExternalGetSetHandler  pGet = NULL,
fbExternalGetSetHandler  pSet = NULL 
) [inherited]

Creation of internal property.

FBProperty* FBProperty::CreateTextureConnectable ( FBComponent pParent,
const char *  pName 
) [inherited]

Creation of user texture connect property.

void FBProperty::SetInternal ( KProperty *  pInternal ) [inherited]

Set internal property.

void FBProperty::SetEnable ( bool  pValue ) [inherited]

Set property enable status.

const char* FBProperty::GetName ( ) [inherited]

Get the property's name.

Returns:
The property's name.
void FBProperty::SetName ( const char *  pName ) [inherited]

Set the property's name.

Parameters:
pName New name for the property.
const char* FBProperty::GetPropertyTypeName ( ) [inherited]

Get the property's type name.

Returns:
The property's type name.
virtual KDataType* FBProperty::GetDataType ( ) [virtual, inherited]

Get the property datatype pointer.

Returns:
Datatype of property (NULL in the case of the FBProperty is not internal).

Reimplemented in FBPropertyAnimatable.

int FBProperty::AsInt ( ) [inherited]

Get the property as an integer.

Returns:
The integer version of the property.
bool FBProperty::SetInt ( int  pInt ) [inherited]

Set the property from an integer.

Parameters:
pInt Int to set property from.
Returns:
True if it was possible.
const char* FBProperty::OriValueAsString ( ) [inherited]

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)
bool FBProperty::IsAnimated ( ) const [inherited]

Get the property animated flag status.

bool FBProperty::OriIsAnimated ( ) const [inherited]

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

virtual bool FBProperty::IsAnimatable ( ) [virtual, inherited]
bool FBProperty::IsInternal ( ) const [inherited]
bool FBProperty::IsUserProperty ( ) [inherited]
bool FBProperty::IsTextureConnectableProperty ( ) [inherited]
bool FBProperty::IsReferenceProperty ( ) [inherited]
bool FBProperty::IsMinClamp ( ) [inherited]

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.
bool FBProperty::IsMaxClamp ( ) [inherited]

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.
bool FBProperty::IsTemporaryProperty ( ) [inherited]

Indicate if a property was created on retrieve because it didn't exist.

Warning:
if there is no call to AcceptTemporaryProperty(), is will be converted to a user property after the file is retrieved.
Returns:
true if property is temporary.
bool FBProperty::AcceptTemporaryProperty ( const char *  pEnumList[] = NULL,
fbExternalGetSetHandler  pGet = NULL,
fbExternalGetSetHandler  pSet = NULL 
) [inherited]

Accept a temporary property as a dynamic property.

Warning:
if there is no call to AcceptTemporaryProperty(), is will be converted to a user property after the file is retrieved.
Returns:
true if property was temporary and converted to a user property.
bool FBProperty::IsObjectList ( ) [inherited]

Indicate if is an instance of FBPropertyListObject.

Warning:
A FBPropertyListObject will also return true on a call to 'IsList()'.
virtual const char* FBProperty::EnumList ( int  pIndex ) [virtual, inherited]

Return the string of an enum value.

Parameters:
pIndex Enum value to get string for.
Returns:
String value of enum specified by pIndex.

Reimplemented in FBPropertyBaseEnum< tType >, FBPropertyBaseAnimatableEnum< tType >, FBPropertyBaseEnum< EPathEndCapStyle >, FBPropertyBaseEnum< ELengthUnitType >, and FBPropertyBaseEnum< EAreaLightShapes >.

FBStringList* FBProperty::GetEnumStringList ( bool  pCreateIt = false ) [inherited]

String list for enum properties.

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

Notify system that the enum list was modified.

void FBProperty::ModifyPropertyFlag ( FBPropertyFlag  pFlag,
bool  pValue 
) [inherited]

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.
FBPropertyFlag FBProperty::GetPropertyFlags ( ) [inherited]

GetPropertyFlags.

Returns:
Return all flags at once.
bool FBProperty::GetPropertyFlag ( FBPropertyFlag  pFlag ) [inherited]

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.
void FBProperty::SetMinMax ( double  pMin,
double  pMax,
bool  pForceMinClamp = false,
bool  pForceMaxClamp = false 
) [inherited]

SetMinMax.

Parameters:
pMin Minimum value of the property.
pMax Maximum value of the property.
pForceMinClamp Force clamping to minimum value of the property.
pForceMaxClamp Force clamping to maximum value of the property.
void FBProperty::SetMin ( double  pMin,
bool  pForceMinClamp = false 
) [inherited]

SetMin.

Parameters:
pMin Minimum value of the property.
pForceMinClamp Force clamping to minimum value of the property.
void FBProperty::SetMax ( double  pMax,
bool  pForceMaxClamp = false 
) [inherited]

SetMax.

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

GetMin.

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

GetMax.

Returns:
Maximum value for the property.
void* FBProperty::GetParent ( ) [inline, inherited]

Get the parent of the object.

Returns:
Parent object.

Definition at line 420 of file fbproperties.h.

{ return mParent; } 
int FBProperty::GetSubMemberCount ( ) const [inherited]

GetSubMemberCount.

Returns:
Number of sub-members.
bool FBProperty::AllowsLocking ( ) const [inherited]

AllowsLocking.

Returns:
true if property can be locked
bool FBProperty::HasSomethingLocked ( ) const [inherited]

HasSomethingLocked.

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

IsLocked.

Returns:
true if property is locked
bool FBProperty::IsMemberLocked ( int  pIndex ) const [inherited]

IsMemberLocked.

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

SetLocked.

Parameters:
pLocked True if the property is to be locked, false if it is to be unlocked.
void FBProperty::SetMemberLocked ( int  pIndex,
bool  pLocked 
) [inherited]

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.
virtual HIObject FBPlug::GetHIObject ( ) const [virtual, inherited]

Return an internal pointer.

virtual bool FBPlug::SetHIObject ( HIObject  pObject,
bool  pSDKComponent 
) [virtual, inherited]

Assign component to an internal pointer.

Reimplemented in FBComponent.

bool FBPlug::IsSDKComponent ( ) [inherited]

Return whether or not item is an SDK component.

bool FBPlug::ConnectSrc ( FBPlug pSrc,
FBConnectionType  pConnectionType = kFBConnectionTypeNone 
) [inherited]

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).
bool FBPlug::ConnectDst ( FBPlug pDst,
FBConnectionType  pConnectionType = kFBConnectionTypeNone 
) [inherited]

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)
bool FBPlug::ConnectSrcAt ( int  pDst_SrcIndex,
FBPlug pSrc,
FBConnectionType  pConnectionType = kFBConnectionTypeNone 
) [inherited]

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).
bool FBPlug::ConnectDstAt ( int  pSrc_DstIndex,
FBPlug pDst,
FBConnectionType  pConnectionType = kFBConnectionTypeNone 
) [inherited]

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).
bool FBPlug::DisconnectDst ( FBPlug pDst ) [inherited]

Remove a destination connection.

Parameters:
pDst Destination plug.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::DisconnectSrc ( FBPlug pSrc ) [inherited]

Remove a source connection.

Parameters:
pSrc Source plug.
Returns:
A boolean indicating success (True) or failure (False).
void FBPlug::DisconnectAllSrc ( ) [inherited]

Remove all source connections.

void FBPlug::DisconnectAllDst ( ) [inherited]

Remove all destination connections.

bool FBPlug::DisconnectDstAt ( int  pIndex ) [inherited]

Remove a destination connection at a specified index.

Parameters:
pIndex Destination plug index.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::DisconnectSrcAt ( int  pIndex ) [inherited]

Remove a source connection at a specified index.

Parameters:
pIndex Source plug index.
Returns:
A boolean indicating success (True) or failure (False).
bool FBPlug::ReplaceDstAt ( int  pIndex,
FBPlug pDst 
) [inherited]

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).
bool FBPlug::ReplaceSrcAt ( int  pIndex,
FBPlug pSrc 
) [inherited]

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).
bool FBPlug::SwapSrc ( int  pIndexA,
int  pIndexB 
) [inherited]

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).
bool FBPlug::MoveSrcAt ( int  pIndex,
int  pAtIndex 
) [inherited]

Move source connection at pIndex to pAtIndex.

Parameters:
pIndex Plug current index.
pAtIndex Plug new index.
Returns:
A boolean indicating success (True) or failure (False).
Remarks:
This is not like the swap function since the connection at pAtIndex is untouched.
bool FBPlug::MoveSrcAt ( FBPlug pSrc,
FBPlug pAtSrc 
) [inherited]

Move source connection pSrc to the position of pAtSrc.

Parameters:
pSrc Plug.
pAtSrc Plug that mark where we want to insert (will insert before this one).
Returns:
A boolean indicating success (True) or failure (False).
Remarks:
This is not like the swap function since the connection at pAtSrc is untouched.
int FBPlug::GetSrcCount ( ) [inherited]

Get source connection count.

Returns:
Total sources connections count.
FBPlug* FBPlug::GetSrc ( int  pIndex ) [inherited]

Get a source connection's plug at specified index.

Parameters:
pIndex Index of the source connection's plug.
Returns:
Source plug at specified index.
FBConnectionType FBPlug::GetSrcType ( int  pIndex ) [inherited]

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.
int FBPlug::GetDstCount ( ) [inherited]

Get destination connection count.

Returns:
Total destinations connections count.
FBPlug* FBPlug::GetDst ( int  pIndex ) [inherited]

Get a destination connection's plug at specified index.

Parameters:
pIndex Index of the destination connection's plug.
Returns:
Destination plug at specified index.
FBConnectionType FBPlug::GetDstType ( int  pIndex ) [inherited]

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.
bool FBPlug::BeginChange ( ) [inherited]

Begins a change on multiple plugs.

Returns:
A boolean indicating success (True) or failure (False).
void FBPlug::EndChange ( ) [inherited]

Ends a change on multiple plugs.

void FBPlug::SetSelfModified ( FBPlugModificationFlag  pFlag,
bool  pBool 
) [inherited]

Set the plug's self modification flag.

Parameters:
pFlag bitwise AND of self modification flags.
pBool true if self changed.
bool FBPlug::GetSelfModified ( FBPlugModificationFlag  pFlag ) [inherited]

Tell if the plug's self has changed.

Parameters:
pFlag bitwise AND of self modification flags.
Returns:
true if self changed
void FBPlug::SetContentModified ( FBPlugModificationFlag  pFlag,
bool  pBool 
) [inherited]

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

Parameters:
pFlag bitwise AND of content modification flags.
pBool true if content has modification.
bool FBPlug::GetContentModified ( FBPlugModificationFlag  pFlag ) [inherited]

Tell if the plug's content has changed.

Parameters:
pFlag bitwise AND of content modification flags.
Returns:
true if content connection changed.
int FBPlug::GetPlugConnectionModifiedList ( FBPlugList pPlugList,
FBPlugModificationFlag  pConnectionModificatonFlag,
bool  pAddRemove 
) [inherited]

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;
bool FBPlug::RevertModification ( FBPlugModificationFlag  pFlag = kFBAllModifiedMask ) [inherited]

Revert the plug's modification to original status.

Parameters:
pFlag the type of modification to be reverted.
Returns:
true if revert successfully.
void FBPlug::SetStatusFlag ( FBPlugStatusFlag  pStatus,
bool  pValue 
) [inherited]

Set the plug's status flag.

Parameters:
pStatus bitwise AND of status flags.
pValue true if status has modification.
bool FBPlug::GetStatusFlag ( FBPlugStatusFlag  pStatus ) const [inherited]

Tell if the plug's status has changed.

Parameters:
pStatus bitwise AND of self modification flags.
Returns:
true if self changed
FBPlug* FBPlug::GetOwner ( ) [inherited]

Get the owner of this plug.

Very useful for properties since they are plugs too.

Returns:
The owner of this plug.
FBPlug* FBPlug::GetOwned ( int  pIndex ) [inherited]

Get the owned plug at specified index.

Parameters:
pIndex Index of the owned plug to get.
Returns:
The owned plug at specified index.
int FBPlug::GetOwnedCount ( ) [inherited]

Get the owned plug count.

Returns:
The owned plug count.
virtual const char* FBPlug::ClassName ( ) [virtual, inherited]

internal System vars.

Reimplemented in FBComponent, and FBCustomManager.

virtual bool FBPlug::Is ( int  pTypeId ) [virtual, inherited]

Is( int pTypeId )

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

Reimplemented in FBComponent, and FBCustomManager.

virtual int FBPlug::GetTypeId ( ) [virtual, inherited]

GetTypeId( int pTypeId )

Returns:
The TypeInfo of the object

Reimplemented in FBComponent, and FBCustomManager.

virtual bool FBPlug::PlugDataNotify ( FBConnectionAction  pAction,
FBPlug pThis,
void *  pData = NULL,
void *  pDataOld = NULL,
int  pDataSize = 0 
) [virtual, inherited]

PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only.

Parameters:
pAction Plug action, the event type.
pThis Plug concerned.
pData Current data, meaning depends of plug action.
pDataOld Previous data, meaning depends of plug action.
pDataSize Size of data.
Returns:
unused should return true
virtual bool FBPlug::PlugStateNotify ( FBConnectionAction  pAction,
FBPlug pThis,
void *  pData = NULL,
void *  pDataOld = NULL,
int  pDataSize = 0 
) [virtual, inherited]

PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only.

Parameters:
pAction Plug action, the event type.
pThis Plug concerned.
pData Current data, meaning depends of plug action.
pDataOld Previous data, meaning depends of plug action.
pDataSize Size of data.
Returns:
unused should return true except in the case of property rename kFBRename
virtual bool FBPlug::PlugNotify ( FBConnectionAction  pAction,
FBPlug pThis,
int  pIndex,
FBPlug pPlug = NULL,
FBConnectionType  pConnectionType = kFBConnectionTypeNone,
FBPlug pNewPlug = NULL 
) [virtual, inherited]

PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only.

Parameters:
pAction Plug action, the event type.
pThis Plug concerned.
pIndex Index of the plug.
pPlug Other plug concerned.
pConnectionType Connection type between the plugs.
pNewPlug New plug (for the replace event).
Returns:
should by default return true except in the case of connection requests (kFBRequestConnectSrc or kFBRequestConnectDst)
FBPlug::ICallback_Declare ( K_IMPLEMENTATION  ) [inherited]
static void FBPlug::PrintClassDefinitions ( ) [static, inherited]

Print out internal Class (ID) Definition table.

For internal debug purpose only.

virtual void FBPlug::FBDelete ( ) [protected, virtual, inherited]
static int FBPlug::GetInternalClassId ( ) [static, protected, inherited]

Internal class Id.

Reimplemented in FBComponent, and FBCustomManager.

FBScriptWrapper* FBWrapperHolder::GetWrapper ( ) [inherited]

Return the wrapper interface of this FBObject.

void FBWrapperHolder::AddWrapper ( FBScriptWrapper ) [inherited]
void FBWrapperHolder::RemoveWrapper ( FBScriptWrapper ) [inherited]

Friends And Related Function Documentation

K_DLLIMPORT friend int __FBRegisterTypeInfo ( int  pInternalClassId ) [friend, inherited]

__FBRegisterTypeInfo For internal use only, Register the TypeInfo mapped to internal class id.


Member Data Documentation

FBString FBProperty::mName [protected, inherited]

mName Property unique name.

Definition at line 198 of file fbproperties.h.

void* FBProperty::mParent [protected, inherited]

mParent Parent of the property.

Definition at line 200 of file fbproperties.h.

const char* FBPlug::ClassGroupName [static, inherited]

ClassGroupName of the object.

Definition at line 444 of file fbplug.h.

bool FBPlug::mAllocated [inherited]

Contain the Allocation State of the Component.

Definition at line 450 of file fbplug.h.

int FBPlug::mGlobalTypeInfo [static, protected, inherited]

Represente the Type Index.

Definition at line 500 of file fbplug.h.

HIObject FBPlug::mObject [protected, inherited]

Handle on the Plug.

Definition at line 502 of file fbplug.h.

bool FBPlug::mSDKComponent [protected, inherited]

bool Plug is an SDK component.

Definition at line 503 of file fbplug.h.


The documentation for this class was generated from the following file: