#include <fbproperties.h>
Property: StringList
Definition at line 964 of file fbproperties.h.
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. |
FBPropertyStringList::FBPropertyStringList | ( | ) |
Constructor.
virtual FBPropertyStringList::~FBPropertyStringList | ( | ) | [virtual] |
Destructor.
FBPropertyStringList* FBPropertyStringList::Init | ( | FBComponent * | pComponent, |
const char * | pName | ||
) |
Property initialization function.
pComponent | Owner component. |
pName | Name of FBPropertyStringList |
kReference FBPropertyStringList::GetReferenceAt | ( | int | pIndex | ) |
Get the reference at pIndex
.
pIndex | Index to get reference at. |
pIndex
.void FBPropertyStringList::SetReferenceAt | ( | int | pIndex, |
kReference | pRef | ||
) |
Set reference at pIndex
.
pIndex | Index to set reference at. |
pRef | Reference to store. |
int FBPropertyStringList::Find | ( | kReference | pRef | ) |
Find the index of a reference.
pRef | Reference to find in list. |
int FBPropertyStringList::Find | ( | const char * | S | ) |
Find the index of a string.
S | String to find in list. |
S
.virtual const char* FBPropertyStringList::GetAt | ( | int | pIndex | ) | [virtual] |
Get the string stored at pIndex
.
pIndex | Index to access |
pIndex
.const char* FBPropertyStringList::operator[] | ( | int | pIndex | ) |
[] operator overload.
Return the string stored at pIndex
.
pIndex | Index to access. |
pIndex
.void FBPropertyStringList::Sort | ( | ) |
Sort list ascending.
int FBPropertyStringList::GetCount | ( | ) |
Get the number of items in the list.
int FBPropertyStringList::Remove | ( | const char * | S | ) |
Remove a string from the list.
S | String to remove from the list. |
virtual int FBPropertyStringList::Add | ( | const char * | S, |
kReference | pRef = 0 |
||
) | [virtual] |
Add a string to the list.
S | String to add to list. |
pRef | Reference to stored with string (default = 0) |
virtual void FBPropertyStringList::Clear | ( | ) | [virtual] |
Clear the list (remove all the items).
virtual void FBPropertyStringList::RemoveAt | ( | int | pIndex | ) | [virtual] |
Remove an entry at pIndex
.
pIndex | Index where item is to be removed from. |
virtual int FBPropertyStringList::IndexOf | ( | const char * | S | ) | [virtual] |
Get the index of a string.
S | String to look for. |
S
was found.virtual void FBPropertyStringList::InsertAt | ( | int | pIndex, |
const char * | S, | ||
kReference | pRef = 0 |
||
) | [virtual] |
Insert an entry at pIndex
.
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
.
pIndex | Index where string is to be set. |
pString | String to set value at pIndex with. |
virtual bool FBPropertyStringList::IsList | ( | ) | [override, virtual] |
virtual const char* FBPropertyStringList::AsString | ( | FBDataAsStringFlag | pFlag =
kFBDataAsStringUI |
) | [override, virtual] |
Get as string.
pFlag | Specifies the purpose of returned string it defaults to kFBDataAsStringUI. |
Reimplemented from FBProperty.
virtual bool FBPropertyStringList::SetString | ( | const char * | pString | ) | [override, virtual] |
Set string for list.
pString | String to set for list, with format same as AsString(kFBDataAsStringPersistence) |
Reimplemented from FBProperty.
virtual FBPropertyType FBPropertyStringList::GetPropertyType | ( | ) | [inline, override, virtual] |
Get the property's type.
Reimplemented from FBProperty.
Definition at line 1087 of file fbproperties.h.
{ return kFBPT_stringlist; }
FBProperty::IObject_Declare | ( | K_IMPLEMENTATION | ) | [inherited] |
FBProperty* FBProperty::InitInternal | ( | KProperty * | pProperty | ) | [inherited] |
Initialize internal pointer.
KProperty* FBProperty::GetInternal | ( | ) | const [inherited] |
Get property.
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] |
void FBProperty::SetName | ( | const char * | pName | ) | [inherited] |
const char* FBProperty::GetPropertyTypeName | ( | ) | [inherited] |
virtual KDataType* FBProperty::GetDataType | ( | ) | [virtual, inherited] |
Get the property datatype pointer.
Reimplemented in FBPropertyAnimatable.
virtual void FBProperty::SetData | ( | void * | pData | ) | [virtual, inherited] |
Set the value of the property, passing the type as an argument.
pData | Value to affect property with. |
Reimplemented in FBPropertyBase< tType, pPT >, FBPropertyAnimatable, FBPropertyBase< ELengthUnitType, kFBPT_enum >, FBPropertyBase< FBTimeSpan, kFBPT_TimeSpan >, FBPropertyBase< FBProperty *, kFBPT_Reference >, FBPropertyBase< FBColor, kFBPT_ColorRGB >, FBPropertyBase< FBColorAndAlpha, kFBPT_ColorRGBA >, FBPropertyBase< double, kFBPT_double >, FBPropertyBase< tType, kFBPT_object >, FBPropertyBase< int, kFBPT_int >, FBPropertyBase< bool, kFBPT_bool >, FBPropertyBase< tType, kFBPT_enum >, FBPropertyBase< bool, kFBPT_Action >, FBPropertyBase< FBVector2d, kFBPT_Vector2D >, FBPropertyBase< FBVector3d, kFBPT_Vector3D >, FBPropertyBase< FBTime, kFBPT_Time >, FBPropertyBase< const char *, kFBPT_charptr >, FBPropertyBase< EPathEndCapStyle, kFBPT_enum >, FBPropertyBase< EAreaLightShapes, kFBPT_enum >, FBPropertyBase< kReference, kFBPT_kReference >, FBPropertyBase< FBPlug *, kFBPT_object >, FBPropertyBase< FBComponent *, kFBPT_object >, and FBPropertyBase< float, kFBPT_float >.
virtual void FBProperty::GetData | ( | void * | pData, |
int | pSize, | ||
FBEvaluateInfo * | pEvalInfo =
NULL |
||
) | const [virtual, inherited] |
Get the value of a property.
pData | Value to fill with property's current value. |
pSize | Size of pData buffer |
pEvalInfo | Used only with animated properties |
Reimplemented in FBPropertyBase< tType, pPT >, FBPropertyAnimatable, FBPropertyBase< ELengthUnitType, kFBPT_enum >, FBPropertyBase< FBTimeSpan, kFBPT_TimeSpan >, FBPropertyBase< FBProperty *, kFBPT_Reference >, FBPropertyBase< FBColor, kFBPT_ColorRGB >, FBPropertyBase< FBColorAndAlpha, kFBPT_ColorRGBA >, FBPropertyBase< double, kFBPT_double >, FBPropertyBase< tType, kFBPT_object >, FBPropertyBase< int, kFBPT_int >, FBPropertyBase< bool, kFBPT_bool >, FBPropertyBase< tType, kFBPT_enum >, FBPropertyBase< bool, kFBPT_Action >, FBPropertyBase< FBVector2d, kFBPT_Vector2D >, FBPropertyBase< FBVector3d, kFBPT_Vector3D >, FBPropertyBase< FBTime, kFBPT_Time >, FBPropertyBase< const char *, kFBPT_charptr >, FBPropertyBase< EPathEndCapStyle, kFBPT_enum >, FBPropertyBase< EAreaLightShapes, kFBPT_enum >, FBPropertyBase< kReference, kFBPT_kReference >, FBPropertyBase< FBPlug *, kFBPT_object >, FBPropertyBase< FBComponent *, kFBPT_object >, and FBPropertyBase< float, kFBPT_float >.
int FBProperty::AsInt | ( | ) | [inherited] |
Get the property as an integer.
bool FBProperty::SetInt | ( | int | pInt | ) | [inherited] |
Set the property from an integer.
pInt | Int to set property from. |
const char* FBProperty::OriValueAsString | ( | ) | [inherited] |
Get the property original value (before any modification) as string.
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] |
Reimplemented in FBPropertyAnimatable.
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.
bool FBProperty::IsMaxClamp | ( | ) | [inherited] |
Indicate if maximum value clamping will be applied on user input value.
bool FBProperty::IsTemporaryProperty | ( | ) | [inherited] |
Indicate if a property was created on retrieve because it didn't exist.
bool FBProperty::AcceptTemporaryProperty | ( | const char * | pEnumList[] =
NULL , |
fbExternalGetSetHandler | pGet = NULL , |
||
fbExternalGetSetHandler | pSet = NULL |
||
) | [inherited] |
Accept a temporary property as a dynamic property.
bool FBProperty::IsObjectList | ( | ) | [inherited] |
Indicate if is an instance of FBPropertyListObject.
virtual bool FBProperty::IsReadOnly | ( | ) | [virtual, inherited] |
Is property read-only?
Reimplemented in FBPropertyBase< tType, pPT >, FBPropertyBase< ELengthUnitType, kFBPT_enum >, FBPropertyBase< FBTimeSpan, kFBPT_TimeSpan >, FBPropertyBase< FBProperty *, kFBPT_Reference >, FBPropertyBase< FBColor, kFBPT_ColorRGB >, FBPropertyBase< FBColorAndAlpha, kFBPT_ColorRGBA >, FBPropertyBase< double, kFBPT_double >, FBPropertyBase< tType, kFBPT_object >, FBPropertyBase< int, kFBPT_int >, FBPropertyBase< bool, kFBPT_bool >, FBPropertyBase< tType, kFBPT_enum >, FBPropertyBase< bool, kFBPT_Action >, FBPropertyBase< FBVector2d, kFBPT_Vector2D >, FBPropertyBase< FBVector3d, kFBPT_Vector3D >, FBPropertyBase< FBTime, kFBPT_Time >, FBPropertyBase< const char *, kFBPT_charptr >, FBPropertyBase< EPathEndCapStyle, kFBPT_enum >, FBPropertyBase< EAreaLightShapes, kFBPT_enum >, FBPropertyBase< kReference, kFBPT_kReference >, FBPropertyBase< FBPlug *, kFBPT_object >, FBPropertyBase< FBComponent *, kFBPT_object >, and FBPropertyBase< float, kFBPT_float >.
virtual const char* FBProperty::EnumList | ( | int | pIndex | ) | [virtual, inherited] |
Return the string of an enum value.
pIndex | Enum value to get string for. |
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.
pCreateIt | Create a new list if necessary. |
void FBProperty::NotifyEnumStringListChanged | ( | ) | [inherited] |
Notify system that the enum list was modified.
void FBProperty::ModifyPropertyFlag | ( | FBPropertyFlag | pFlag, |
bool | pValue | ||
) | [inherited] |
ModifyPropertyFlag.
pFlag | The flag to switch to True or False. |
pValue | The value to set about this flag. |
FBPropertyFlag FBProperty::GetPropertyFlags | ( | ) | [inherited] |
bool FBProperty::GetPropertyFlag | ( | FBPropertyFlag | pFlag | ) | [inherited] |
GetPropertyFlag.
pFlag | Flag to test if it is True or False. |
void FBProperty::SetMinMax | ( | double | pMin, |
double | pMax, | ||
bool | pForceMinClamp =
false , |
||
bool | pForceMaxClamp =
false |
||
) | [inherited] |
SetMinMax.
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.
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.
pMax | Maximum value of the property. |
pForceMaxClamp | Force clamping to maximum value of the property. |
double FBProperty::GetMin | ( | ) | [inherited] |
double FBProperty::GetMax | ( | ) | [inherited] |
void* FBProperty::GetParent | ( | ) | [inline, inherited] |
Get the parent of the object.
Definition at line 420 of file fbproperties.h.
{ return mParent; }
int FBProperty::GetSubMemberCount | ( | ) | const [inherited] |
bool FBProperty::AllowsLocking | ( | ) | const [inherited] |
bool FBProperty::HasSomethingLocked | ( | ) | const [inherited] |
HasSomethingLocked.
bool FBProperty::IsLocked | ( | ) | const [inherited] |
bool FBProperty::IsMemberLocked | ( | int | pIndex | ) | const [inherited] |
IsMemberLocked.
pIndex | Index of the sub-member of the property to check. |
void FBProperty::SetLocked | ( | bool | pLocked | ) | [inherited] |
SetLocked.
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.
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] |
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.
pSrc | Source plug. |
pConnectionType | Type of connection, taken from FBConnectionType. Default value should work in all cases. |
bool FBPlug::ConnectDst | ( | FBPlug * | pDst, |
FBConnectionType | pConnectionType =
kFBConnectionTypeNone |
||
) | [inherited] |
Add a destination connection.
pDst | Destination plug. |
pConnectionType | Type of connection, taken from FBConnectionType. Default value should work in all cases. |
bool FBPlug::ConnectSrcAt | ( | int | pDst_SrcIndex, |
FBPlug * | pSrc, | ||
FBConnectionType | pConnectionType =
kFBConnectionTypeNone |
||
) | [inherited] |
Add a source connection.
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. |
bool FBPlug::ConnectDstAt | ( | int | pSrc_DstIndex, |
FBPlug * | pDst, | ||
FBConnectionType | pConnectionType =
kFBConnectionTypeNone |
||
) | [inherited] |
Add a destination connection.
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. |
bool FBPlug::DisconnectDst | ( | FBPlug * | pDst | ) | [inherited] |
Remove a destination connection.
pDst | Destination plug. |
bool FBPlug::DisconnectSrc | ( | FBPlug * | pSrc | ) | [inherited] |
Remove a source connection.
pSrc | Source plug. |
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.
pIndex | Destination plug index. |
bool FBPlug::DisconnectSrcAt | ( | int | pIndex | ) | [inherited] |
Remove a source connection at a specified index.
pIndex | Source plug index. |
bool FBPlug::ReplaceDstAt | ( | int | pIndex, |
FBPlug * | pDst | ||
) | [inherited] |
Replace a destination connection at a specified index.
pIndex | Destination plug index. |
pDst | Plug that will replace the other at index. |
bool FBPlug::ReplaceSrcAt | ( | int | pIndex, |
FBPlug * | pSrc | ||
) | [inherited] |
Replace a source connection at a specified index.
pIndex | Source plug index. |
pSrc | Plug that will replace the other at index. |
bool FBPlug::SwapSrc | ( | int | pIndexA, |
int | pIndexB | ||
) | [inherited] |
Swap source connection at index A with source connection at index B.
pIndexA | Plug index. |
pIndexB | Other plug index. |
bool FBPlug::MoveSrcAt | ( | int | pIndex, |
int | pAtIndex | ||
) | [inherited] |
Move source connection at pIndex to pAtIndex.
pIndex | Plug current index. |
pAtIndex | Plug new index. |
Move source connection pSrc to the position of pAtSrc.
pSrc | Plug. |
pAtSrc | Plug that mark where we want to insert (will insert before this one). |
int FBPlug::GetSrcCount | ( | ) | [inherited] |
FBPlug* FBPlug::GetSrc | ( | int | pIndex | ) | [inherited] |
Get a source connection's plug at specified index.
pIndex | Index of the source connection's plug. |
FBConnectionType FBPlug::GetSrcType | ( | int | pIndex | ) | [inherited] |
Get a source connection's type at specified index.
pIndex | Index of the source connection's type. |
int FBPlug::GetDstCount | ( | ) | [inherited] |
Get destination connection count.
FBPlug* FBPlug::GetDst | ( | int | pIndex | ) | [inherited] |
Get a destination connection's plug at specified index.
pIndex | Index of the destination connection's plug. |
FBConnectionType FBPlug::GetDstType | ( | int | pIndex | ) | [inherited] |
Get a destination connection's type at specified index.
pIndex | Index of the destination connection's type. |
bool FBPlug::BeginChange | ( | ) | [inherited] |
Begins a change on multiple plugs.
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.
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.
pFlag | bitwise AND of self modification flags. |
void FBPlug::SetContentModified | ( | FBPlugModificationFlag | pFlag, |
bool | pBool | ||
) | [inherited] |
Set the plug's owned property/object's modification flag.
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.
pFlag | bitwise AND of content modification flags. |
int FBPlug::GetPlugConnectionModifiedList | ( | FBPlugList & | pPlugList, |
FBPlugModificationFlag | pConnectionModificatonFlag, | ||
bool | pAddRemove | ||
) | [inherited] |
Get plug's modified src/dst property/object connection added/removed List.
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. |
bool FBPlug::RevertModification | ( | FBPlugModificationFlag | pFlag =
kFBAllModifiedMask |
) | [inherited] |
Revert the plug's modification to original status.
pFlag | the type of modification to be reverted. |
void FBPlug::SetStatusFlag | ( | FBPlugStatusFlag | pStatus, |
bool | pValue | ||
) | [inherited] |
Set the plug's status flag.
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.
pStatus | bitwise AND of self modification flags. |
FBPlug* FBPlug::GetOwner | ( | ) | [inherited] |
Get the owner of this plug.
Very useful for properties since they are plugs too.
FBPlug* FBPlug::GetOwned | ( | int | pIndex | ) | [inherited] |
Get the owned plug at specified index.
pIndex | Index of the owned plug to get. |
int FBPlug::GetOwnedCount | ( | ) | [inherited] |
virtual const char* FBPlug::ClassName | ( | ) | [virtual, inherited] |
virtual bool FBPlug::Is | ( | int | pTypeId | ) | [virtual, inherited] |
pTypeId | Type Identification. |
Reimplemented in FBComponent, and FBCustomManager.
virtual int FBPlug::GetTypeId | ( | ) | [virtual, inherited] |
GetTypeId( int pTypeId )
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.
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. |
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.
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. |
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.
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). |
FBPlug::ICallback_Declare | ( | K_IMPLEMENTATION | ) | [inherited] |
Reimplemented in FBComponent, FBModel, and FBVisualComponent.
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] |
Actual destructor for a FBPlug.
It should never be called from client code. This is meant for internal use only!
Reimplemented in FBAudioClip, FBActor, FBCharacter, FBCharacterExtension, FBActorFace, FBCharacterFace, FBComponent, FBContainer, FBFCurve, FBAnimationLayer, FBTake, FBFolder, FBGroup, FBSet, FBImage, FBKeyingGroup, FBModel, FBMotionClip, FBScene, FBStoryFolder, FBStoryTrack, FBStoryClip, FBTexture, FBLayeredTexture, FBVideoClip, and FBGenericMenu.
static int FBPlug::GetInternalClassId | ( | ) | [static, protected, inherited] |
FBScriptWrapper* FBWrapperHolder::GetWrapper | ( | ) | [inherited] |
Return the wrapper interface of this FBObject.
void FBWrapperHolder::AddWrapper | ( | FBScriptWrapper * | ) | [inherited] |
void FBWrapperHolder::RemoveWrapper | ( | FBScriptWrapper * | ) | [inherited] |
K_DLLIMPORT friend int __FBRegisterTypeInfo | ( | int | pInternalClassId | ) | [friend, inherited] |
__FBRegisterTypeInfo For internal use only, Register the TypeInfo mapped to internal class id.
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] |
int FBPlug::TypeInfo
[static, inherited] |
TypeInfo.
Reimplemented in FBComponent, FBCustomManager, FBPropertyBaseComponent< tType >, FBPropertyBaseComponent< FBPlug * >, and FBPropertyBaseComponent< FBComponent * >.
bool FBPlug::mAllocated
[inherited] |
Contain the Allocation State of the Component.
int FBPlug::mGlobalTypeInfo
[static, protected, inherited] |
HIObject FBPlug::mObject
[protected, inherited] |
bool FBPlug::mSDKComponent
[protected, inherited] |