List of scene objects. More...

#include <fbcomponent.h>

Inheritance diagram for FBPropertyListObject:

[legend]

Public Member Functions
	FBPropertyListObject ()
	Constructor.

virtual int	GetCount ()
	Get the object count.

virtual FBComponent *	operator[] (int pIndex)
	Get the object at pIndex.

virtual FBComponent *	GetAt (int pIndex)
	Get the Component at pIndex.

virtual int	Add (FBComponent *pObject)
	Add an object at the end of the list.

virtual int	SetAt (int pIndex, FBComponent *pObject)
	Replace an existing entry at a specific index.

virtual void	RemoveAt (int pIndex)
	Remove an object at a specific index.

virtual int	InsertAt (int pIndex, FBComponent *pObject)
	Insert an object at a specific index.

virtual void	Clear ()
	Clears the content of the list.

virtual void	SetSingleConnect (bool pSingleConnect)
	Set if the connection is single or multiple.

virtual int	GetSingleConnect ()
	Get if the connection support only one connection.

void	SetFilter (int pInternalClassId)
	Set the filter connections to the property list (UI only).

int	GetFilter ()
	Get the filter class Id for the property list (UI only).

virtual FBComponent *	GetAt (int pIndex)
	Get the Component at pIndex.

Public Member Functions inherited from FBPropertyListComponentBase
	FBPropertyListComponentBase ()
	Constructor.

virtual int	Add (FBComponent *pItem)
	Add a component to the list.

virtual void	RemoveAt (int pIndex) override
	Remove the component at pIndex from list.

virtual FBComponent *	GetAt (int pIndex)=0
	Get the Component at pIndex.

FBComponent *	operator[] (int pIndex)
	Get the Component at pIndex.

virtual int	GetCount () override
	Get the Component count.

virtual int	Find (FBComponent *pItem)
	Locate a property in the list.

virtual int	Remove (FBComponent *pItem)
	Remove pItem from the list.

void	SetClassId (int pClassId)

int	GetClassId ()

void	SetListOfParents (bool pListOfParents)

bool	GetIsListOfParents ()

virtual FBPropertyType	GetPropertyType () override
	Get the property's type.

Public Member Functions inherited from FBPropertyBasicList
	FBPropertyBasicList ()
	Constructor.

	FBPropertyBasicList (HIObject pParent, const char *pName)
	Constructor.

FBProperty *	Init (void pParent, const char pName)
	Initialization function.

void	RemoveAll ()
	Remove all properties from the list.

virtual int	GetCount ()=0
	Get the number of properties in the list.

virtual void	RemoveAt (int pIndex)=0
	Remove property at `pIndex`.

virtual bool	IsList ()
	Is this a list?

Public Member Functions inherited from FBProperty
	FBProperty ()
	Constructor.

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.

virtual FBPropertyType	GetPropertyType ()
	Get the property's type.

const char *	GetPropertyTypeName ()
	Get the property's type name.

virtual KDataType *	GetDataType ()
	Get the property datatype pointer.

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.

int	AsInt ()
	Get the property as an integer.

bool	SetInt (int pInt)
	Set the property from an integer.

virtual const char *	AsString (FBDataAsStringFlag pFlag=kFBDataAsStringUI)
	Get the property value as a string.

virtual bool	SetString (const char *pString)
	Set the property value from a string.

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)

virtual bool	IsList ()
	Verify if property is of this type.

virtual bool	IsAnimatable ()

bool	IsInternal () const

bool	IsUserProperty ()

bool	IsTextureConnectableProperty ()

bool	IsReferenceProperty ()

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.

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.

FBProperty *	GetReferencedProperty ()
	Get the referenced property, in the case of this property is a reference property (see the IsReferenceProperty() method).

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject.

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Additional Inherited Members
Protected Member Functions inherited from FBPlug
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.

virtual void	FBDelete ()
	Actual destructor for a FBPlug.

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id.

Protected Attributes inherited from FBPropertyListComponentBase
int	mClassId
	Class Id.

bool	mParents
	mParent.

Protected Attributes inherited from FBProperty
FBString	mName

void *	mParent

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component.

HIObject	mObject
	Handle on the Plug.

bool	mSDKComponent
	bool Plug is an SDK component.

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object.

static int	TypeInfo
	TypeInfo.

static int	mGlobalTypeInfo
	Represente the Type Index.

Detailed Description

List of scene objects.

This list is a more generic container often used as object properties. The types of actual object that it can contain can be specialized.

Definition at line 572 of file fbcomponent.h.

Constructor & Destructor Documentation

◆ FBPropertyListObject()

FBPropertyListObject ( )

Constructor.

Member Function Documentation

◆ Add()

virtual int Add ( FBComponent * pObject )

virtual

Add an object at the end of the list.

Parameters

pObject Object to add to list.

Returns: Index of the newly added object. A return value of '-1' indicated the the object has not been added.

Reimplemented from FBPropertyListComponentBase.

◆ Clear()

virtual void Clear ( )

virtual

Clears the content of the list.

◆ GetAt()

virtual FBComponent * GetAt ( int pIndex )

virtual

Get the Component at pIndex.

Parameters

pIndex Index of Component to get a handle on.

Returns: Component at pIndex.

Reimplemented from FBPropertyListComponent.

◆ GetCount()

virtual int GetCount ( )

virtual

Get the object count.

Returns: Number of Objects.

Reimplemented from FBPropertyListComponentBase.

◆ GetFilter()

int GetFilter ( )

Get the filter class Id for the property list (UI only).

Returns: MBClassId used for filtering connections (-1 equal no filter).

◆ GetSingleConnect()

virtual int GetSingleConnect ( )

virtual

Get if the connection support only one connection.

Returns: true is the connection support only one connection.

◆ InsertAt()

virtual int InsertAt	(	int	pIndex,
		FBComponent *	pObject
	)

virtual

Insert an object at a specific index.

Parameters

pIndex	Index where the object should be inserted.
pObject	Object to insert in the list.

Returns: Index of the inserted object. A return value of '-1' indicated the the object has not been inserted.

◆ operator[]()

virtual FBComponent * operator[] ( int pIndex )

virtual

Get the object at pIndex.

Parameters

pIndex Index of the object to query.

Returns: The object at pIndex.

◆ RemoveAt()

virtual void RemoveAt ( int pIndex )

virtual

Remove an object at a specific index.

Parameters

pIndex Index of the object that should be removed.

Reimplemented from FBPropertyListComponentBase.

◆ SetAt()

virtual int SetAt	(	int	pIndex,
		FBComponent *	pObject
	)

virtual

Replace an existing entry at a specific index.

Parameters

pIndex	Index of the object that should be replaced.
pObject	Object to insert in the list.

Returns: Index of the replaced object. A return value of '-1' indicated the the object has not been replaced.

◆ SetFilter()

void SetFilter ( int pInternalClassId )

Set the filter connections to the property list (UI only).

Parameters

pInternalClassId used for filtering connections; should be taken from object::GetInternalClassId() (-1 equal no filter).

◆ SetSingleConnect()

virtual void SetSingleConnect ( bool pSingleConnect )

virtual

Set if the connection is single or multiple.

Parameters

pSingleConnect set to true for only one connection allowed.

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

fbcomponent.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBPropertyListObject()

Member Function Documentation

◆ Add()

◆ Clear()

◆ GetAt()

◆ GetCount()

◆ GetFilter()

◆ GetSingleConnect()

◆ InsertAt()

◆ operator[]()

◆ RemoveAt()

◆ SetAt()

◆ SetFilter()

◆ SetSingleConnect()