FBMaterial Class Reference


Detailed Description

Inheritance diagram for FBMaterial:
Inheritance graph
[legend]

List of all members.

Public Member Functions

  __init__ (str pName, object pObject=None)
  Constructor.
FBMaterial  Clone ()
  Clone the material.
HFBTexture  GetTexture (FBMaterialTextureType=kFBMaterialTextureDiffuse)
  Retrieve associated texture.
  SetTexture (FBTexture pTexture, FBMaterialTextureType pType=kFBMaterialTextureDiffuse)
  Set associated texture.
  OGLInit ()
  Setup OpenGL fixed pipeline material settings.
str  GetMaterialName ()
  Return Material Name.
str  GetMaterialDesc ()
  Return Material Desc Name.
bool  FbxStore (HFBFbxObject pFbxObject, kFbxObjectStore pStoreWhat)
  Store and Retrieve function that can be overloaded.
bool  FbxRetrieve (HFBFbxObject pFbxObject, kFbxObjectStore pStoreWhat)
str  FbxGetObjectType ()
  Returns the class type inherited by the class of an object, for example: 'Material'.
str  FbxGetObjectSubType ()
  Returns the class sub type inherited by the class of an object, for example: 'Default', 'Custom Material'.

Public Attributes

FBPropertyBaseAnimatable  Ambient
  Read Write Property: Ambient color.
FBPropertyBaseAnimatable  AmbientFactor
  Read Write Property: Ambient Factor value.
FBPropertyBaseAnimatable  Emissive
  Read Write Property: Emissive color.
FBPropertyBaseAnimatable  EmissiveFactor
  Read Write Property: Emissive Factor value.
FBPropertyBaseAnimatable  Diffuse
  Read Write Property: Diffuse color.
FBPropertyBaseAnimatable  DiffuseFactor
  Read Write Property: Diffuse Factor value.
FBPropertyBaseAnimatable  TransparentColor
  Read Write Property: Transparent color.
FBPropertyBaseAnimatable  TransparencyFactor
  Read Write Property: Transparency Factor value.
FBPropertyBaseAnimatable  Bump
  Read Write Property: Bump.
FBPropertyBaseAnimatable  NormalMap
  Read Write Property: Normal Map.
FBPropertyBaseAnimatable  BumpFactor
  Read Write Property: Bump Factor value.
FBPropertyBaseAnimatable  Specular
  Read Write Property: Specular color.
FBPropertyBaseAnimatable  SpecularFactor
  Read Write Property: Specular Factor value.
FBPropertyBaseAnimatable  Shininess
  Read Write Property: Shininess value.
FBPropertyBaseAnimatable  Reflection
  Read Write Property: Reflection color.
FBPropertyBaseAnimatable  ReflectionFactor
  Read Write Property: Reflection Factor value.
FBPropertyBaseAnimatable  DisplacementColor
  Read Write Property: Displacement color.
FBPropertyBaseAnimatable  DisplacementFactor
  Read Write Property: Displacement Factor value.

Protected Member Functions

HFBProperty  CreateTextureConnectableUserProperty (str pName, FBPropertyType pType, str pDataType, bool pAnimatable)
  Create user custom texture connect property for custom material derived from FBMaterial only.

Member Function Documentation

__init__ ( str  pName,
object  pObject = None 
)
FBMaterial Clone ( )

Clone the material.

This will duplicated the current material.

Returns:
Newly created material.
HFBTexture GetTexture ( FBMaterialTextureType  = kFBMaterialTextureDiffuse )

Retrieve associated texture.

Parameters:
pType MaterialTextureType to get connected texture from (default is Diffuse is not specified).
SetTexture ( FBTexture  pTexture,
FBMaterialTextureType  pType = kFBMaterialTextureDiffuse 
)

Set associated texture.

Parameters:
pTexture texture to be connected.
pType MaterialTextureType to set connected texture to.
OGLInit ( )

Setup OpenGL fixed pipeline material settings.

str GetMaterialName ( )

Return Material Name.

Need to be same with FBMaterialLayout

str GetMaterialDesc ( )

Return Material Desc Name.

Need to be same with FBMaterialLayout

bool FbxStore ( HFBFbxObject  pFbxObject,
kFbxObjectStore  pStoreWhat 
)

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.
bool FbxRetrieve ( HFBFbxObject  pFbxObject,
kFbxObjectStore  pStoreWhat 
)
str FbxGetObjectType ( )

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

Reimplemented from FBBox.

str FbxGetObjectSubType ( )

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

Reimplemented from FBBox.

HFBProperty CreateTextureConnectableUserProperty ( str  pName,
FBPropertyType  pType,
str  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.

Member Data Documentation

FBPropertyBaseAnimatable Ambient

Read Write Property: Ambient color.

FBPropertyBaseAnimatable AmbientFactor

Read Write Property: Ambient Factor value.

FBPropertyBaseAnimatable Emissive

Read Write Property: Emissive color.

FBPropertyBaseAnimatable EmissiveFactor

Read Write Property: Emissive Factor value.

FBPropertyBaseAnimatable Diffuse

Read Write Property: Diffuse color.

FBPropertyBaseAnimatable DiffuseFactor

Read Write Property: Diffuse Factor value.

FBPropertyBaseAnimatable TransparentColor

Read Write Property: Transparent color.

FBPropertyBaseAnimatable TransparencyFactor

Read Write Property: Transparency Factor value.

FBPropertyBaseAnimatable Bump

Read Write Property: Bump.

FBPropertyBaseAnimatable NormalMap

Read Write Property: Normal Map.

FBPropertyBaseAnimatable BumpFactor

Read Write Property: Bump Factor value.

FBPropertyBaseAnimatable Specular

Read Write Property: Specular color.

FBPropertyBaseAnimatable SpecularFactor

Read Write Property: Specular Factor value.

FBPropertyBaseAnimatable Shininess

Read Write Property: Shininess value.

FBPropertyBaseAnimatable Reflection

Read Write Property: Reflection color.

FBPropertyBaseAnimatable ReflectionFactor

Read Write Property: Reflection Factor value.

FBPropertyBaseAnimatable DisplacementColor

Read Write Property: Displacement color.

FBPropertyBaseAnimatable DisplacementFactor

Read Write Property: Displacement Factor value.


FBMaterial FBMaterial FBMaterial FBMaterial FBMaterial FBMaterial FBMaterial FBMaterial FBMaterial FBMaterial
FBMaterial FBMaterial FBMaterial FBMaterial FBMaterial FBMaterial FBMaterial FBMaterial FBMaterial FBMaterial