Material class. More...

#include <fbmaterial.h>

Inheritance diagram for FBMaterial:

[legend]

Public Member Functions
	FBMaterial (const char *pName, HIObject pObject=NULL)
	Constructor.

FBMaterial *	Clone ()
	Clone the material.

FBTexture *	GetTexture (FBMaterialTextureType pType=kFBMaterialTextureDiffuse)
	Retrieve associated texture.

void	SetTexture (FBTexture *pTexture, FBMaterialTextureType pType=kFBMaterialTextureDiffuse)
	Set associated texture.

void	OGLInit ()
	Setup OpenGL fixed pipeline material settings.

virtual const char *	GetMaterialName () const
	Return Material Name.

virtual const char *	GetMaterialDesc () const
	Return Material Desc Name.

virtual bool	FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat) override
	Store and Retrieve function that can be overloaded.

virtual bool	FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat) override

virtual const char *	FbxGetObjectType () override
	Returns the class type inherited by the class of an object, for example: 'Material'.

virtual const char *	FbxGetObjectSubType () override
	Returns the class sub type inherited by the class of an object, for example: 'Default', 'Custom Material', 'FBMaterial'.

Public Member Functions inherited from FBBox
	FBBox (const char *pName, HIObject pObject=NULL)
	Constructor.

virtual FBAnimationNode *	AnimationNodeInCreate (kReference pUserId, const char pName, const char pDataType, bool pIsPublic=false, double pMin=NULL, double pMax=NULL, bool pUserData=false)
	Creation of IN/OUT Animation Nodes.

virtual FBAnimationNode *	AnimationNodeOutCreate (kReference pUserId, const char pName, const char pDataType, bool pIsPublic=false, double pMin=NULL, double pMax=NULL, bool pUserData=false)

virtual bool	EvaluateAnimationNodes (FBEvaluateInfo *pEvaluateInfo)
	Evaluation of non TRS nodes that needs to be evaluated.

virtual bool	AnimationNodeNotify (FBAnimationNode pAnimationNode, FBEvaluateInfo pEvaluateInfo)
	Notification function for animation thread.

virtual bool	ResolveCandidate (FBAnimationNode pAnimationNode, FBEvaluateInfo pEvaluateInfo)
	Function is call when candidate needs to be resolved (like global to local).

virtual ECandidateAction	SetGlobalCandidate (FBAnimationNode pAnimationNode, double pData, FBEvaluateInfo *pEvaluateInfo)
	Function is call when a global candidate is set on an animation node.

virtual ECandidateAction	SetStdCandidate (FBAnimationNode pAnimationNode, double pData, FBEvaluateInfo *pEvaluateInfo)
	Function is call when a non-global candidate is set on an animation node.

virtual bool	FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)
	Storage/Retrieval of information into the FBX file format.

virtual bool	FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)

virtual bool	AnimationNodeDestroy (FBAnimationNode *pAnimationNode)
	Destroy an animation node.

virtual bool	AnimationNodeIsUserData (FBAnimationNode *pAnimationNode)
	Is the animation node user data?

virtual void	AnimationNodesOutDisableIfNotWritten (FBEvaluateInfo *pEvaluateInfo)
	This call will disable all out animation nodes from being pull by system (animation thread) for given pEvaluateInfo.

virtual FBAnimationNode *	AnimationNodeInGet ()
	Get the (IN/OUT) animation node for this box.

virtual FBAnimationNode *	AnimationNodeOutGet ()

virtual const char *	FbxGetObjectType ()
	Returns the class type inherited by the class of an object, for example: 'Box', 'Constraint', 'TimelineXTrack'.

virtual const char *	FbxGetObjectSubType ()
	Returns the class sub type inherited by the class of an object, for example: 'Relations', 'Parent-Child', 'Number to Vector', 'Shot'.

	IObject_Declare (override)

virtual int	GetOutConnectorCount () const
	Get the number of animation node outputs for this box.

virtual int	GetInConnectorCount () const
	Get the number of animation node inputs for this box.

virtual FBAnimationNode *	GetOutConnector (int pIndex) const
	Get the animation node output associated with the given index.

virtual FBAnimationNode *	GetInConnector (int pIndex) const
	Get the animation node input associated with the given index.

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor.

virtual	~FBComponent ()
	Destructor.

virtual bool	FBCreate ()
	Open Reality Creation function.

virtual void	FBDestroy ()
	Open Reality destruction function.

virtual void	FBDelete () override
	Open Reality deletion function.

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer.

virtual int	PropertyAdd (FBProperty *pProperty)
	Add a property to the component's property manager.

bool	PropertyAddReferenceProperty (FBProperty *pReferenceProperty)
	Add a reference property to the component's property manager.

void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager.

void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property.

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.

void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy.

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace.

virtual const char *	ClassName () override
	Get the class name.

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not.

const char *	GetFullName (void)
	Get the full name.

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object.

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object.

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object.

void	HardSelect ()
	HardSelect.

virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId.

virtual int	GetTypeId () override
	GetTypeId( int pTypeId )

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

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Public Attributes
FBPropertyAnimatableColor	Ambient
	Read Write Property: Ambient color.

FBPropertyAnimatableDouble	AmbientFactor
	Read Write Property: Ambient Factor value.

FBPropertyAnimatableColor	Emissive
	Read Write Property: Emissive color.

FBPropertyAnimatableDouble	EmissiveFactor
	Read Write Property: Emissive Factor value.

FBPropertyAnimatableColor	Diffuse
	Read Write Property: Diffuse color.

FBPropertyAnimatableDouble	DiffuseFactor
	Read Write Property: Diffuse Factor value.

FBPropertyAnimatableColor	TransparentColor
	Read Write Property: Transparent color.

FBPropertyAnimatableDouble	TransparencyFactor
	Read Write Property: Transparency Factor value.

FBPropertyAnimatableColor	Bump
	Read Write Property: Bump.

FBPropertyAnimatableColor	NormalMap
	Read Write Property: Normal Map.

FBPropertyAnimatableDouble	BumpFactor
	Read Write Property: Bump Factor value.

FBPropertyAnimatableColor	Specular
	Read Write Property: Specular color.

FBPropertyAnimatableDouble	SpecularFactor
	Read Write Property: Specular Factor value.

FBPropertyAnimatableDouble	Shininess
	Read Write Property: Shininess value.

FBPropertyAnimatableColor	Reflection
	Read Write Property: Reflection color.

FBPropertyAnimatableDouble	ReflectionFactor
	Read Write Property: Reflection Factor value.

FBPropertyAnimatableColor	DisplacementColor
	Read Write Property: Displacement color.

FBPropertyAnimatableDouble	DisplacementFactor
	Read Write Property: Displacement Factor value.

Public Attributes inherited from FBBox
const char *	UniqueName
	internal Unique name.

FBPropertyBool	Animatable
	Read Write Property: Is the box animatable.

FBPropertyBool	Live
	Read Write Property: Is live?

FBPropertyBool	RecordMode
	Read Write Property: Is recording?

Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component.

FBPropertyListComponent	Components
	List: List of components.

FBPropertyListComponent	Parents
	List: Parents.

FBPropertyBool	Selected
	Read Write Property: Selected property.

FBPropertyString	Name
	Read Write Property: Unique name of object.

FBPropertyString	LongName
	Read Write Property: Name and namespace for object.

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component.

Protected Member Functions
FBProperty *	CreateTextureConnectableUserProperty (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable)
	Create user custom texture connect property for custom material derived from FBMaterial only.

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.

Additional Inherited Members
Public Types inherited from FBBox
enum	ECandidateAction { eCandidateAccept , eCandidateIntercept , eCandidateInterceptAfterEvaluation }
	Resolving action for candidates. More...

Static Public Member Functions inherited from FBComponent
static int	GetInternalClassId ()

static void	FBComponentSetName (FBComponent pObject, const char pName)

static const char *	FBComponentGetName (FBComponent *pObject)

static void	FBComponentSetLongName (FBComponent pObject, const char pName)

static const char *	FBComponentGetLongName (FBComponent *pObject)

Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object.

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

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

Material class.

Definition at line 87 of file fbmaterial.h.

Constructor & Destructor Documentation

◆ FBMaterial()

FBMaterial	(	const char *	pName,
		HIObject	pObject = `NULL`
	)

Constructor.

Parameters

pName	Name of material.
pObject	For internal use only(default=NULL).

Member Function Documentation

◆ Clone()

FBMaterial * Clone ( )

Clone the material.

This will duplicated the current material.

Returns: Newly created material.

◆ CreateTextureConnectableUserProperty()

FBProperty * CreateTextureConnectableUserProperty	(	const char *	pName,
		FBPropertyType	pType,
		const char *	pDataType,
		bool	pAnimatable
	)

protected

Create user custom texture connect property for custom material derived from FBMaterial only.

Parameters

pName	The name of the property.
pType	Type of the property. See enum FBPropertyType.
pDataType	DataType of the property.
pAnimatable	To specify if the property can be animated..

Returns: The custom property created.

Remarks: Only support Color, ColorAndAlpha, Number, Vector, Vector2, Vector4 data type for user texture connect property.

◆ FbxGetObjectSubType()

virtual const char * FbxGetObjectSubType ( )

overridevirtual

Returns the class sub type inherited by the class of an object, for example: 'Default', 'Custom Material', 'FBMaterial'.

Returns: The class sub type inherited by the class of an object.

Reimplemented from FBBox.

◆ FbxGetObjectType()

virtual const char * FbxGetObjectType ( )

overridevirtual

Returns the class type inherited by the class of an object, for example: 'Material'.

Returns: The class type inherited by the class of an object.

Reimplemented from FBBox.

◆ FbxRetrieve()

virtual bool FbxRetrieve	(	FBFbxObject *	pFbxObject,
		kFbxObjectStore	pStoreWhat
	)

overridevirtual

Reimplemented from FBBox.

◆ FbxStore()

virtual bool FbxStore	(	FBFbxObject *	pFbxObject,
		kFbxObjectStore	pStoreWhat
	)

overridevirtual

Store and Retrieve function that can be overloaded.

Parameters

pFbxObject	FBX Object that is used to communicate I/O operations.
pStoreWhat	Which attributes are currently stored/retrieved.

Reimplemented from FBBox.

◆ GetMaterialDesc()

virtual const char * GetMaterialDesc ( ) const

virtual

Return Material Desc Name.

Need to be same with FBMaterialLayout

◆ GetMaterialName()

virtual const char * GetMaterialName ( ) const

virtual

Return Material Name.

Need to be same with FBMaterialLayout

◆ GetTexture()

FBTexture * GetTexture ( FBMaterialTextureType pType = kFBMaterialTextureDiffuse )

Retrieve associated texture.

Parameters

pType MaterialTextureType to get connected texture from (default is Diffuse is not specified).

◆ OGLInit()

void OGLInit ( )

Setup OpenGL fixed pipeline material settings.

◆ SetTexture()

void SetTexture	(	FBTexture *	pTexture,
		FBMaterialTextureType	pType = `kFBMaterialTextureDiffuse`
	)

Set associated texture.

Parameters

pTexture	texture to be connected.
pType	MaterialTextureType to set connected texture to.

Member Data Documentation

◆ Ambient

FBPropertyAnimatableColor Ambient

Read Write Property: Ambient color.

Definition at line 102 of file fbmaterial.h.

◆ AmbientFactor

FBPropertyAnimatableDouble AmbientFactor

Read Write Property: Ambient Factor value.

Definition at line 103 of file fbmaterial.h.

◆ Bump

FBPropertyAnimatableColor Bump

Read Write Property: Bump.

Definition at line 114 of file fbmaterial.h.

◆ BumpFactor

FBPropertyAnimatableDouble BumpFactor

Read Write Property: Bump Factor value.

Definition at line 116 of file fbmaterial.h.

◆ Diffuse

FBPropertyAnimatableColor Diffuse

Read Write Property: Diffuse color.

Definition at line 108 of file fbmaterial.h.

◆ DiffuseFactor

FBPropertyAnimatableDouble DiffuseFactor

Read Write Property: Diffuse Factor value.

Definition at line 109 of file fbmaterial.h.

◆ DisplacementColor

FBPropertyAnimatableColor DisplacementColor

Read Write Property: Displacement color.

Definition at line 125 of file fbmaterial.h.

◆ DisplacementFactor

FBPropertyAnimatableDouble DisplacementFactor

Read Write Property: Displacement Factor value.

Definition at line 126 of file fbmaterial.h.

◆ Emissive

FBPropertyAnimatableColor Emissive

Read Write Property: Emissive color.

Definition at line 105 of file fbmaterial.h.

◆ EmissiveFactor

FBPropertyAnimatableDouble EmissiveFactor

Read Write Property: Emissive Factor value.

Definition at line 106 of file fbmaterial.h.

◆ NormalMap

FBPropertyAnimatableColor NormalMap

Read Write Property: Normal Map.

Definition at line 115 of file fbmaterial.h.

◆ Reflection

FBPropertyAnimatableColor Reflection

Read Write Property: Reflection color.

Definition at line 122 of file fbmaterial.h.

◆ ReflectionFactor

FBPropertyAnimatableDouble ReflectionFactor

Read Write Property: Reflection Factor value.

Definition at line 123 of file fbmaterial.h.

◆ Shininess

FBPropertyAnimatableDouble Shininess

Read Write Property: Shininess value.

Definition at line 120 of file fbmaterial.h.

◆ Specular

FBPropertyAnimatableColor Specular

Read Write Property: Specular color.

Definition at line 118 of file fbmaterial.h.

◆ SpecularFactor

FBPropertyAnimatableDouble SpecularFactor

Read Write Property: Specular Factor value.

Definition at line 119 of file fbmaterial.h.

◆ TransparencyFactor

FBPropertyAnimatableDouble TransparencyFactor

Read Write Property: Transparency Factor value.

Definition at line 112 of file fbmaterial.h.

◆ TransparentColor

FBPropertyAnimatableColor TransparentColor

Read Write Property: Transparent color.

Definition at line 111 of file fbmaterial.h.

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

fbmaterial.h

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBMaterial()

Member Function Documentation

◆ Clone()

◆ CreateTextureConnectableUserProperty()

◆ FbxGetObjectSubType()

◆ FbxGetObjectType()

◆ FbxRetrieve()

◆ FbxStore()

◆ GetMaterialDesc()

◆ GetMaterialName()

◆ GetTexture()

◆ OGLInit()

◆ SetTexture()

Member Data Documentation

◆ Ambient

◆ AmbientFactor

◆ Bump

◆ BumpFactor

◆ Diffuse

◆ DiffuseFactor

◆ DisplacementColor

◆ DisplacementFactor

◆ Emissive

◆ EmissiveFactor

◆ NormalMap

◆ Reflection

◆ ReflectionFactor

◆ Shininess

◆ Specular

◆ SpecularFactor

◆ TransparencyFactor

◆ TransparentColor