FBPropertyBaseList< tType > Class Template Reference

FBPropertyBaseList< tType > Class Template Referenceabstract

#include <fbproperties.h>

Class Description

template<class tType>
class ORSDK2019::FBPropertyBaseList< tType >

Base template class for list properties.

Definition at line 888 of file fbproperties.h.

+ Inheritance diagram for FBPropertyBaseList< tType >:

Public Member Functions

 FBPropertyBaseList ()
 Constructor. More...
 
 ~FBPropertyBaseList ()
 Destructor. More...
 
 FBPropertyBaseList (HIObject pParent, const char *pName)
 Constructor. More...
 
virtual int Add (tType pItem)=0
 Add a property to the list. More...
 
virtual tType operator[] (int pIndex)=0
 [] operator overload. More...
 
virtual int Find (tType pItem)
 Locate a property in the list. More...
 
virtual int Remove (tType pItem)
 Remove pItem from the list. More...
 
virtual tType GetAt (int pIndex)
 Get a property at pIndex. More...
 
- Public Member Functions inherited from FBPropertyBasicList
 FBPropertyBasicList ()
 Constructor. More...
 
 ~FBPropertyBasicList ()
 
 FBPropertyBasicList (HIObject pParent, const char *pName)
 Constructor. More...
 
FBPropertyInit (void *pParent, const char *pName)
 Initialization function. More...
 
void RemoveAll ()
 Remove all properties from the list. More...
 
virtual int GetCount ()=0
 Get the number of properties in the list. More...
 
virtual void RemoveAt (int pIndex)=0
 Remove property at pIndex. More...
 
virtual bool IsList ()
 Is this a list? More...
 
- Public Member Functions inherited from FBProperty
virtual const char * ClassName () override
 internal System vars. More...
 
virtual bool Is (int pTypeId) override
 Is( int pTypeId ) More...
 
virtual void FBDelete () override
 Actual destructor for a FBPlug. More...
 
virtual int GetTypeId () override
 GetTypeId( int pTypeId ) More...
 
virtual ~FBProperty ()
 
 FBProperty ()
 Constructor. More...
 
void SetEnable (bool pValue)
 Set property enable status. More...
 
const char * GetName ()
 Get the property's name. More...
 
void SetName (const char *pName)
 Set the property's name. More...
 
virtual FBPropertyType GetPropertyType ()
 Get the property's type. More...
 
const char * GetPropertyTypeName ()
 Get the property's type name. More...
 
virtual KDataType * GetDataType ()
 Get the property datatype pointer. More...
 
int AsInt ()
 Get the property as an integer. More...
 
bool SetInt (int pInt)
 Set the property from an integer. More...
 
virtual const char * AsString (FBDataAsStringFlag pFlag=kFBDataAsStringUI)
 Get the property value as a string. More...
 
virtual bool SetString (const char *pString)
 Set the property value from a string. More...
 
const char * OriValueAsString ()
 Get the property original value (before any modification) as string. More...
 
bool IsAnimated () const
 Get the property animated flag status. More...
 
bool OriIsAnimated () const
 Get the property original animated flag status (before any modification) More...
 
bool IsMinClamp ()
 Indicate if minimum value clamping will be applied on user input value. More...
 
bool IsMaxClamp ()
 Indicate if maximum value clamping will be applied on user input value. More...
 
bool IsTemporaryProperty ()
 Indicate if a property was created on retrieve because it didn't exist. More...
 
bool AcceptTemporaryProperty (const char *pEnumList[]=((void *) 0), fbExternalGetSetHandler pGet=((void *) 0), fbExternalGetSetHandler pSet=((void *) 0))
 Accept a temporary property as a dynamic property. More...
 
bool IsObjectList ()
 Indicate if is an instance of FBPropertyListObject. More...
 
virtual bool IsReadOnly ()
 Is property read-only? More...
 
virtual const char * EnumList (int pIndex)
 Return the string of an enum value. More...
 
FBStringListGetEnumStringList (bool pCreateIt=false)
 String list for enum properties. More...
 
void NotifyEnumStringListChanged ()
 Notify system that the enum list was modified. More...
 
void ModifyPropertyFlag (FBPropertyFlag pFlag, bool pValue)
 ModifyPropertyFlag. More...
 
FBPropertyFlag GetPropertyFlags ()
 GetPropertyFlags. More...
 
bool GetPropertyFlag (FBPropertyFlag pFlag)
 GetPropertyFlag. More...
 
void SetMinMax (double pMin, double pMax, bool pForceMinClamp=false, bool pForceMaxClamp=false)
 SetMinMax. More...
 
void SetMin (double pMin, bool pForceMinClamp=false)
 SetMin. More...
 
void SetMax (double pMax, bool pForceMaxClamp=false)
 SetMax. More...
 
double GetMin ()
 GetMin. More...
 
double GetMax ()
 GetMax. More...
 
void * GetParent ()
 Get the parent of the object. More...
 
virtual void SetData (void *pData)
 Set the value of the property, passing the type as an argument. More...
 
virtual void GetData (void *pData, int pSize, FBEvaluateInfo *pEvalInfo=((void *) 0)) const
 Get the value of a property. More...
 
virtual bool IsAnimatable ()
 
bool IsInternal () const
 
bool IsUserProperty ()
 
bool IsTextureConnectableProperty ()
 
bool IsReferenceProperty ()
 
int GetSubMemberCount () const
 GetSubMemberCount. More...
 
bool AllowsLocking () const
 AllowsLocking. More...
 
bool HasSomethingLocked () const
 HasSomethingLocked. More...
 
bool IsLocked () const
 IsLocked. More...
 
bool IsMemberLocked (int pIndex) const
 IsMemberLocked. More...
 
void SetLocked (bool pLocked)
 SetLocked. More...
 
void SetMemberLocked (int pIndex, bool pLocked)
 SetMemberLocked. More...
 
- Public Member Functions inherited from IObject
virtual HIObject IQuery (kInterfaceID pInterfaceID, int IsLocal=0)=0
 
virtual void Destroy (int IsLocal=0)=0
 
- Public Member Functions inherited from FBWrapperHolder
 FBWrapperHolder ()
 
virtual ~FBWrapperHolder ()
 
FBScriptWrapperGetWrapper ()
 Return the wrapper interface of this FBObject. More...
 
void AddWrapper (FBScriptWrapper *)
 
void RemoveWrapper (FBScriptWrapper *)
 

Additional Inherited Members

- Public Types inherited from FBProperty
typedef FBPlug ParentClass
 
- Static Public Attributes inherited from FBProperty
static int TypeInfo
 
- Protected Member Functions inherited from FBPlug
bool IsSDKComponent ()
 Return whether or not item is an SDK component. More...
 
bool ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a source connection. More...
 
bool ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a destination connection. More...
 
bool ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a source connection. More...
 
bool ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
 Add a destination connection. More...
 
bool DisconnectDst (FBPlug *pDst)
 Remove a destination connection. More...
 
bool DisconnectSrc (FBPlug *pSrc)
 Remove a source connection. More...
 
void DisconnectAllSrc ()
 Remove all source connections. More...
 
void DisconnectAllDst ()
 Remove all destination connections. More...
 
bool DisconnectDstAt (int pIndex)
 Remove a destination connection at a specified index. More...
 
bool DisconnectSrcAt (int pIndex)
 Remove a source connection at a specified index. More...
 
bool ReplaceDstAt (int pIndex, FBPlug *pDst)
 Replace a destination connection at a specified index. More...
 
bool ReplaceSrcAt (int pIndex, FBPlug *pSrc)
 Replace a source connection at a specified index. More...
 
bool SwapSrc (int pIndexA, int pIndexB)
 Swap source connection at index A with source connection at index B. More...
 
bool MoveSrcAt (int pIndex, int pAtIndex)
 Move source connection at pIndex to pAtIndex. More...
 
bool MoveSrcAt (FBPlug *pSrc, FBPlug *pAtSrc)
 Move source connection pSrc to the position of pAtSrc. More...
 
int GetSrcCount ()
 Get source connection count. More...
 
FBPlugGetSrc (int pIndex)
 Get a source connection's plug at specified index. More...
 
FBConnectionType GetSrcType (int pIndex)
 Get a source connection's type at specified index. More...
 
int GetDstCount ()
 Get destination connection count. More...
 
FBPlugGetDst (int pIndex)
 Get a destination connection's plug at specified index. More...
 
FBConnectionType GetDstType (int pIndex)
 Get a destination connection's type at specified index. More...
 
bool BeginChange ()
 Begins a change on multiple plugs. More...
 
void EndChange ()
 Ends a change on multiple plugs. More...
 
void SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
 Set the plug's self modification flag. More...
 
bool GetSelfModified (FBPlugModificationFlag pFlag)
 Tell if the plug's self has changed. More...
 
void SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
 Set the plug's owned property/object's modification flag. More...
 
bool GetContentModified (FBPlugModificationFlag pFlag)
 Tell if the plug's content has changed. More...
 
int GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
 Get plug's modified src/dst property/object connection added/removed List. More...
 
bool RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
 Revert the plug's modification to original status. More...
 
void SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
 Set the plug's status flag. More...
 
bool GetStatusFlag (FBPlugStatusFlag pStatus) const
 Tell if the plug's status has changed. More...
 
FBPlugGetOwner ()
 Get the owner of this plug. More...
 
FBPlugGetOwned (int pIndex)
 Get the owned plug at specified index. More...
 
int GetOwnedCount ()
 Get the owned plug count. More...
 
virtual bool PlugDataNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=((void *) 0), void *pDataOld=((void *) 0), int pDataSize=0)
 PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only. More...
 
virtual bool PlugStateNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=((void *) 0), void *pDataOld=((void *) 0), int pDataSize=0)
 PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only. More...
 
virtual bool PlugNotify (FBConnectionAction pAction, FBPlug *pThis, int pIndex, FBPlug *pPlug=((void *) 0), FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=((void *) 0))
 PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only. More...
 
- Static Protected Member Functions inherited from FBPlug
static int GetInternalClassId ()
 Internal class Id. More...
 
- Protected Attributes inherited from FBProperty
FBString mName
 Return to the default scope (private) More...
 
void * mParent
 mParent Parent of the property. More...
 
- Protected Attributes inherited from FBPlug
bool mAllocated
 Contain the Allocation State of the Component. More...
 
HIObject mObject
 Handle on the Plug. More...
 
bool mSDKComponent
 bool Plug is an SDK component. More...
 
- Static Protected Attributes inherited from FBPlug
static const char * ClassGroupName
 ClassGroupName of the object. More...
 
static int TypeInfo
 TypeInfo. More...
 
static int mGlobalTypeInfo
 Represente the Type Index. More...
 

Constructor & Destructor Documentation

FBPropertyBaseList ( )
inline

Constructor.

Definition at line 892 of file fbproperties.h.

892 :FBPropertyBasicList( ) {}
FBPropertyBasicList()
Constructor.
~FBPropertyBaseList ( )
inline

Destructor.

Definition at line 895 of file fbproperties.h.

896  {
897 
898  }
FBPropertyBaseList ( HIObject  pParent,
const char *  pName 
)
inline

Constructor.

Parameters
pParentParent for property list.
pNameName of property list.

Definition at line 903 of file fbproperties.h.

903 :FBPropertyBasicList( pParent, pName ) {}
FBPropertyBasicList()
Constructor.

Member Function Documentation

virtual int Add ( tType  pItem)
pure virtual

Add a property to the list.

Parameters
pItemProperty to add.
Returns
Index where property was inserted.
Warning
overload required.

Implemented in FBPropertyListAnimationNode, FBPropertyListRigidBodyMarkers, FBPropertyListModelMarkerOptical, FBPropertyListScene, and FBPropertyListCommPort.

virtual int Find ( tType  pItem)
inlinevirtual

Locate a property in the list.

Parameters
pItemProperty to find in the list.
Returns
Index where pItem can be found.

Definition at line 933 of file fbproperties.h.

934  {
935  int Index;
936  for(Index=0; Index<GetCount(); Index++ )
937  {
938  if( operator[](Index)==pItem )
939  {
940  return Index;
941  }
942  }
943  return -1;
944  }
virtual int GetCount()=0
Get the number of properties in the list.
#define Index(a0, a1)
Definition: Python-ast.h:517
virtual tType GetAt ( int  pIndex)
inlinevirtual

Get a property at pIndex.

Parameters
pIndexIndex to access.
Returns
Property at pIndex.

Definition at line 964 of file fbproperties.h.

965  {
966  return operator[](pIndex);
967  }
virtual tType operator[](int pIndex)=0
[] operator overload.
virtual tType operator[] ( int  pIndex)
pure virtual
virtual int Remove ( tType  pItem)
inlinevirtual

Remove pItem from the list.

Parameters
pItemProperty to remove from the list.
Returns
Index where property was removed.

Reimplemented in FBPropertyListAnimationNode, and FBPropertyListCommPort.

Definition at line 950 of file fbproperties.h.

951  {
952  int Index = Find( pItem );
953  if (Index!=-1)
954  {
955  RemoveAt( Index );
956  }
957  return Index;
958  }
virtual int Find(tType pItem)
Locate a property in the list.
Definition: fbproperties.h:933
#define Index(a0, a1)
Definition: Python-ast.h:517
virtual void RemoveAt(int pIndex)=0
Remove property at pIndex.

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