FBMaterial Class Reference

Material class. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBMaterial:

Public Member Functions
	FBMaterial (str pName)
	Constructor.
FBMaterial	Clone ()
	Clone the material.
FBTexture	GetTexture (FBMaterialTextureType pType=kFBMaterialTextureDiffuse)
	Retrieve associated texture.
	OGLInit ()
	Setup OpenGL fixed pipeline material settings.
	SetTexture (FBTexture pTexture, FBMaterialTextureType pType=kFBMaterialTextureDiffuse)
	Set associated texture.
Public Member Functions inherited from FBBox
	FBBox (str pName)
	Constructor.
bool	AnimationNodeDestroy (FBAnimationNode pAnimationNode)
	Destroy an animation node.
FBAnimationNode	AnimationNodeInGet ()
	Get the (IN/OUT) animation node for this box.
bool	AnimationNodeIsUserData (FBAnimationNode pAnimationNode)
	Is the animation node user data?
FBAnimationNode	AnimationNodeOutGet ()
str	FbxGetObjectSubType ()
	Returns the class sub type inherited by the class of an object, for example: 'Relations', 'Parent-Child', 'Number to Vector', 'Shot'.
str	FbxGetObjectType ()
	Returns the class type inherited by the class of an object, for example: 'Box', 'Constraint', 'TimelineXTrack'.
FBAnimationNode	GetInConnector (int pIndex)
	Get the animation node input associated with the given index.
int	GetInConnectorCount ()
	Get the number of animation node inputs for this box.
FBAnimationNode	GetOutConnector (int pIndex)
	Get the animation node output associated with the given index.
int	GetOutConnectorCount ()
	Get the number of animation node outputs for this box.
Public Member Functions inherited from FBComponent
	FBComponent ()
	Constructor.
str	ClassName ()
	Get the class name.
	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.
	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.
bool	FBCreate ()
	Open Reality Creation function.
	FBDelete ()
	Open Reality deletion function.
	FBDestroy ()
	Open Reality destruction function.
FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).
bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.
FBFileReference	GetOwnerFileReference (p0)
	Get the owner FileReference object.
	HardSelect ()
	HardSelect.
bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.
bool	Is (int pTypeId)
	Returns true if object is of type TypeId.
bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessNamespaceHierarchy.
bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessObjectNamespace.
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.
FBProperty	PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
	Create user or dynamic property.
	PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.
	PropertyRemove (FBProperty pProperty)
	Remove a Property from the component's Property manager.
	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.
	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

Public Attributes
FBAnimatableColor	Ambient
	Read Write Property: Ambient color.
FBAnimatableDouble	AmbientFactor
	Read Write Property: Ambient Factor value.
FBAnimatableColor	Bump
	Read Write Property: Bump.
FBAnimatableDouble	BumpFactor
	Read Write Property: Bump Factor value.
FBAnimatableColor	Diffuse
	Read Write Property: Diffuse color.
FBAnimatableDouble	DiffuseFactor
	Read Write Property: Diffuse Factor value.
FBAnimatableColor	DisplacementColor
	Read Write Property: Displacement color.
FBAnimatableDouble	DisplacementFactor
	Read Write Property: Displacement Factor value.
FBAnimatableColor	Emissive
	Read Write Property: Emissive color.
FBAnimatableDouble	EmissiveFactor
	Read Write Property: Emissive Factor value.
FBAnimatableColor	NormalMap
	Read Write Property: Normal Map.
FBAnimatableColor	Reflection
	Read Write Property: Reflection color.
FBAnimatableDouble	ReflectionFactor
	Read Write Property: Reflection Factor value.
FBAnimatableDouble	Shininess
	Read Write Property: Shininess value.
FBAnimatableColor	Specular
	Read Write Property: Specular color.
FBAnimatableDouble	SpecularFactor
	Read Write Property: Specular Factor value.
FBAnimatableDouble	TransparencyFactor
	Read Write Property: Transparency Factor value.
FBAnimatableColor	TransparentColor
	Read Write Property: Transparent color.
Public Attributes inherited from FBBox
bool	Animatable
	Read Write Property: Is the box animatable.
bool	Live
	Read Write Property: Is live?
bool	RecordMode
	Read Write Property: Is recording?
str	UniqueName
	internal Unique name.
Public Attributes inherited from FBComponent
FBListComponent	Components
	List: List of components.
str	LongName
	Read Write Property: Name and namespace for object.
str	Name
	Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.
FBListComponent	Parents
	List: Parents.
FBManager	PropertyList
	Read Only Property: Manages all of the properties for the component.
bool	Selected
	Read Write Property: Selected property.
int	TypeInfo
	Contains the Type information of the object.
Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.
int	TypeInfo
	TypeInfo.

Detailed Description

Material class.

See samples: MaterialAndTexture.py, TextureAnimation.py, VideoInput.py, VideoMemory.py.

Constructor & Destructor Documentation

FBMaterial()

FBMaterial

(

str

pName

)

Constructor.

Parameters

pName

Name of material.

Member Function Documentation

Clone()

FBMaterial Clone

(

)

Clone the material.

This will duplicated the current material.

Returns

Newly created material.

GetTexture()

FBTexture GetTexture

(

FBMaterialTextureType

pType = kFBMaterialTextureDiffuse

)

Retrieve associated texture.

Parameters

pType

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

OGLInit()

OGLInit

(

)

Setup OpenGL fixed pipeline material settings.

SetTexture()

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

FBAnimatableColor Ambient

Read Write Property: Ambient color.

AmbientFactor

FBAnimatableDouble AmbientFactor

Read Write Property: Ambient Factor value.

Bump

FBAnimatableColor Bump

Read Write Property: Bump.

BumpFactor

FBAnimatableDouble BumpFactor

Read Write Property: Bump Factor value.

Diffuse

FBAnimatableColor Diffuse

Read Write Property: Diffuse color.

DiffuseFactor

FBAnimatableDouble DiffuseFactor

Read Write Property: Diffuse Factor value.

DisplacementColor

FBAnimatableColor DisplacementColor

Read Write Property: Displacement color.

DisplacementFactor

FBAnimatableDouble DisplacementFactor

Read Write Property: Displacement Factor value.

Emissive

FBAnimatableColor Emissive

Read Write Property: Emissive color.

EmissiveFactor

FBAnimatableDouble EmissiveFactor

Read Write Property: Emissive Factor value.

NormalMap

FBAnimatableColor NormalMap

Read Write Property: Normal Map.

Reflection

FBAnimatableColor Reflection

Read Write Property: Reflection color.

ReflectionFactor

FBAnimatableDouble ReflectionFactor

Read Write Property: Reflection Factor value.

Shininess

FBAnimatableDouble Shininess

Read Write Property: Shininess value.

Specular

FBAnimatableColor Specular

Read Write Property: Specular color.

SpecularFactor

FBAnimatableDouble SpecularFactor

Read Write Property: Specular Factor value.

TransparencyFactor

FBAnimatableDouble TransparencyFactor

Read Write Property: Transparency Factor value.

TransparentColor

FBAnimatableColor TransparentColor

Read Write Property: Transparent color.