#include <fbproperties.h>

Class Description

template<class tType, FBPropertyType pPT>
class ORSDK2018::FBPropertyBase< tType, pPT >

Base template class for all standard properties

Definition at line 615 of file fbproperties.h.

Inheritance diagram for FBPropertyBase< tType, pPT >:

Public Types
typedef tType	ValueType
	Property Value Type. More...

Public Types inherited from FBProperty
typedef FBPlug	ParentClass

Public Member Functions
	FBPropertyBase ()
	Constructor. More...

	FBPropertyBase (const FBPropertyBase< tType, pPT > &pValue)
	Constructor. More...

	~FBPropertyBase ()
	Destructor. More...

FBPropertyBase *	Init (void pParent, const char pName, tType(pGet)(void )=((void ) 0), void(pSet)(void , tType)=((void ) 0))
	Initialization function. More...

	operator tType () const
	Overloaded cast to tType operator. More...

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

virtual void	SetPropertyValue (tType pValue)
	Set the value of the internal property. More...

tType	GetPropertyValue ()
	Get the value of the internal property. More...

virtual bool	IsReadOnly ()
	Is this class read-only? If there is an existing set function, this class is read/write, otherwise it is read-only. More...

virtual void	GetData (void pData, int pSize, FBEvaluateInfo pEvalInfo=((void *) 0)) const
	Get value. More...

virtual void	SetData (void *pData)
	Set value. More...


void	operator= (tType pValue)
	Overloaded = operator. More...


void	operator= (const FBPropertyBase< tType, pPT > &pProperty)
	Overloaded = operator. More...

Public Member Functions inherited from FBProperty
virtual const char *	ClassName ()
	internal System vars. More...

virtual bool	Is (int pTypeId)
	Is( int pTypeId ) More...

virtual void	FBDelete ()
	Actual destructor for a FBPlug. More...

virtual int	GetTypeId ()
	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...

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 const char *	EnumList (int pIndex)
	Return the string of an enum value. More...

FBStringList *	GetEnumStringList (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 bool	IsList ()
	Verify if property is of this type. 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 ()

FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject. More...

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Additional Inherited Members
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...

FBPlug *	GetSrc (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...

FBPlug *	GetDst (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...

FBPlug *	GetOwner ()
	Get the owner of this plug. More...

FBPlug *	GetOwned (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...

Member Typedef Documentation

typedef tType ValueType

Property Value Type.

Definition at line 625 of file fbproperties.h.

Constructor & Destructor Documentation

FBPropertyBase ( )

inline

Constructor.

Definition at line 628 of file fbproperties.h.

628 { Set = NULL; Get = NULL; }

Set

#define Set(a0, a1, a2, a3)

Definition: Python-ast.h:467

NULL

#define NULL

Definition: kaydara.h:169

FBPropertyBase ( const FBPropertyBase< tType, pPT > & pValue )

inline

Constructor.

Parameters

pValue FBPropertyBase.

Definition at line 633 of file fbproperties.h.

633 { operator=((tType)pValue ); }

ORSDK2018::FBPropertyBase::operator=

void operator=(tType pValue)

Overloaded = operator.

Definition: fbproperties.h:661

~FBPropertyBase ( )

inline

Destructor.

Definition at line 636 of file fbproperties.h.

637 {

638 }

Member Function Documentation

virtual void GetData	(	void *	pData,
		int	pSize,
		FBEvaluateInfo *	pEvalInfo = `((void *)0)`
	)		const

inlinevirtual

Get value.

Return values

pValue Value to fill with current object value.

Reimplemented from FBProperty.

Definition at line 717 of file fbproperties.h.

         {
             if(Get)
             { 
                 *((tType*)pData) = (*Get)(mParent); 
             } 
             else if (IsInternal())
             {
                 FBProperty::GetData( pData, pSize, pEvalInfo );
             } 
             else
             {
                 assert(Get != NULL || IsInternal());
                 *((tType*)pData) = (tType)0; 
             }
         }

virtual FBPropertyType GetPropertyType ( )

inlinevirtual

Get the property's type.

Returns: The property's type.

Reimplemented from FBProperty.

Definition at line 681 of file fbproperties.h.

681 { return pPT; }

tType GetPropertyValue ( )

inline

Get the value of the internal property.

Returns: Property value.

Definition at line 697 of file fbproperties.h.

         {
             if(IsInternal() && GetValuePtr())
             {
                 return *(tType*)GetValuePtr();
             } else
             {
                 return (tType)0;
             }
         }

FBPropertyBase* Init	(	void *	pParent,
		const char *	pName,
		tType()(void )	pGet = `((void *)0)`,
		void()(void , tType)	pSet = `((void *)0)`
	)

inline

Initialization function.

Parameters

pParent	Parent object.
pName	Name of base enum.
pGet	Get function (default=NULL).
pSet	Set function (default=NULL).

Returns: Pointer to this object.

Definition at line 647 of file fbproperties.h.

         {  
             mParent = pParent;  
             mName   = pName ;   
             Get     = pGet;     
             Set     = pSet;     
             return this;
         } 

virtual bool IsReadOnly ( )

inlinevirtual

Is this class read-only? If there is an existing set function, this class is read/write, otherwise it is read-only.

Returns: true if it is read-only.

Reimplemented from FBProperty.

Definition at line 712 of file fbproperties.h.

712 { return IsInternal() ? (FBProperty::IsReadOnly()) : (Set == NULL); }

Set

#define Set(a0, a1, a2, a3)

Definition: Python-ast.h:467

NULL

#define NULL

Definition: kaydara.h:169

ORSDK2018::FBProperty::IsReadOnly

virtual bool IsReadOnly()

Is property read-only?

ORSDK2018::FBProperty::IsInternal

bool IsInternal() const

operator tType ( ) const

inline

Overloaded cast to tType operator.

Get the value of the current object using Get fuction.

Returns: tType cast of current object.

Definition at line 676 of file fbproperties.h.

676 { tType Value; GetData( &Value,sizeof(Value) ); return Value; }

ORSDK2018::FBPropertyBase::GetData

virtual void GetData(void *pData, int pSize, FBEvaluateInfo *pEvalInfo=((void *) 0)) const

Get value.

Definition: fbproperties.h:717

void operator= ( tType pValue )

inline

Overloaded = operator.

Set the value of the current object using the Set function.

Parameters

pValue Value to set for object.

Definition at line 661 of file fbproperties.h.

661 { SetData( &pValue ); }

ORSDK2018::FBPropertyBase::SetData

virtual void SetData(void *pData)

Set value.

Definition: fbproperties.h:736

void operator= ( const FBPropertyBase< tType, pPT > & pProperty )

inline

Overloaded = operator.

Set the value of the current object with another property value of the same type.

Parameters

pProperty Property to use to set the value.

Definition at line 669 of file fbproperties.h.

669 { operator=((tType)pProperty ); }

ORSDK2018::FBPropertyBase::operator=

void operator=(tType pValue)

Overloaded = operator.

Definition: fbproperties.h:661

virtual void SetData ( void * pData )

inlinevirtual

Set value.

Parameters

pData Integer to use to set.

Reimplemented from FBProperty.

Definition at line 736 of file fbproperties.h.

         { 
             if(Set) 
             { 
                 (*Set)( mParent,*(tType*)pData ); 
             } 
             else if (IsInternal())
             {
                 FBProperty::SetData( pData );
             } 
             else
             { 
                 assert( Set != NULL || IsInternal() ); 
             } 
         } 

virtual void SetPropertyValue ( tType pValue )

inlinevirtual

Set the value of the internal property.

Parameters

pValue Value to set to internal property.

Reimplemented in FBPropertyString.

Definition at line 686 of file fbproperties.h.

         {
             if(IsInternal() && GetValuePtr())
             {
                 *(tType*)GetValuePtr() = pValue;
             }
         }

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

fbsdk/fbproperties.h

FBPropertyBase< tType, pPT > Class Template Reference

Class Description

template<class tType, FBPropertyType pPT> class ORSDK2018::FBPropertyBase< tType, pPT >

Public Types

Public Member Functions

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<class tType, FBPropertyType pPT>
class ORSDK2018::FBPropertyBase< tType, pPT >