KFbxSurfaceMaterial Class Reference

#include <kfbxsurfacematerial.h>

Inherits KFbxTakeNodeContainer.

Inherited by KFbxSurfaceLambert.

Inheritance diagram for KFbxSurfaceMaterial:

Inheritance graph
List of all members.

Detailed Description

Material settings.

A material is attached to an instance of class KFbxGeometry by calling KFbxGeometry::AddMaterial(). Materials can be shared among many instances of class KFbxGeometry.

Definition at line 66 of file kfbxsurfacematerial.h.

Error Management

enum  EError
 Error identifiers. More...
KError const & GetError () const
 Retrieve error object.
EError GetLastErrorID () const
 Get last error code.
char const * GetLastErrorString () const
 Get last error string.

Standard Material Property Names

static char const * sShadingModel
static char const * sMultiLayer
static char const * sEmissive
static char const * sEmissiveFactor
static char const * sAmbient
static char const * sAmbientFactor
static char const * sDiffuse
static char const * sDiffuseFactor
static char const * sSpecular
static char const * sSpecularFactor
static char const * sShininess
static char const * sBump
static char const * sTransparentColor
static char const * sTransparencyFactor
static char const * sReflection
static char const * sReflectionFactor

Material Properties

void Reset ()
 Reset the material to default values.
KFbxProperty GetShadingModel () const
 Reset the material to default values.
KFbxProperty GetMultiLayer () const
 Reset the material to default values.
void AddChannels (KFbxTakeNode *pTakeNode)
 Reset the material to default values.

Deprecated KFbxMaterial interface.

Remarks:
These functions are provided to ease the transition from KFbxMaterial to the new surface materials.


K_DEPRECATED bool SetShadingModel (KString const &pShadingModel)
 Set material shading model.
K_DEPRECATED bool GetShadingModel (KString &pShadingModel) const
 Get material shading model.
K_DEPRECATED bool SetMultiLayer (bool pMultiLayer)
 Set multi layer state flag.
K_DEPRECATED bool GetMultiLayer (bool &pMultiLayer) const
 Get multilayer state.


Member Enumeration Documentation

enum EError

Error identifiers.

  • eTAKE_NODE_ERROR
  • eERROR_COUNT

Definition at line 161 of file kfbxsurfacematerial.h.


Member Function Documentation

void Reset (  ) 

Reset the material to default values.

KFbxProperty GetShadingModel (  )  const

Reset the material to default values.

KFbxProperty GetMultiLayer (  )  const

Reset the material to default values.

void AddChannels ( KFbxTakeNode pTakeNode  ) 

Reset the material to default values.

K_DEPRECATED bool SetShadingModel ( KString const &  pShadingModel  ) 

Set material shading model.

Parameters:
pShadingModel Shading model for the material.
Remarks:
"phong" is the default shading model.

K_DEPRECATED bool GetShadingModel ( KString pShadingModel  )  const

Get material shading model.

Returns:
The shading model type string.

K_DEPRECATED bool SetMultiLayer ( bool  pMultiLayer  ) 

Set multi layer state flag.

Parameters:
pMultiLayer If true, multi-layering is enabled.

K_DEPRECATED bool GetMultiLayer ( bool &  pMultiLayer  )  const

Get multilayer state.

Returns:
The state of the multy-layer flag.

KError const& GetError (  )  const

Retrieve error object.

Returns:
Reference to error object.

EError GetLastErrorID (  )  const

Get last error code.

Returns:
Last error code.

char const* GetLastErrorString (  )  const

Get last error string.

Returns:
Textual description of the last error.