- Main Page
- Classes
- Files
- Directories

- Class List
- Class Hierarchy
- Class Members

Protected Member Functions

# FbxImplementation Class Reference

This reference page is linked to from the following overview topics: Using hardware shaders to create materials.

Search for all occurrences

## Detailed Description

This object represents the shading node implementation.

It defines basic information about the shader and the binding table(FbxBindingTable). For example, you can create a new FbxImplementation like this:

     FbxImplementation* lImpl = FbxImplementation::Create( &pMyScene, "MyImplementation" );
     pMyObject.AddImplementation( lImpl );
     pMyObject.SetDefaultImplementation( lImpl );
     lImpl->RenderAPI = FBXSDK_RENDERING_API_DIRECTX; //FBXSDK_RENDERING_API_DIRECTX, FBXSDK_RENDERING_API_OPENGL, FBXSDK_RENDERING_API_MENTALRAY or FBXSDK_RENDERING_API_PREVIEW
     lImpl->RenderAPIVersion = "9.0"; //API Version

     lImpl->Language = FBXSDK_SHADING_LANGUAGE_HLSL; //FBXSDK_SHADING_LANGUAGE_HLSL, FBXSDK_SHADING_LANGUAGE_GLSL, FBXSDK_SHADING_LANGUAGE_CGFX or FBXSDK_SHADING_LANGUAGE_MRSL
     lImpl->LanguageVersion = "1.0";  //Language Version

After the new FbxImplementation is created, you can access FbxBindingTable like this:

     FbxBindingTable* lTable = lImpl->GetTableByTargetName("root");

Also, you can access the exist FbxImplementation in FbxObject by this:

     const FbxImplementation* lImpl = GetImplementation( pMyObject, FBXSDK_IMPLEMENTATION_CGFX ); // FBXSDK_IMPLEMENTATION_PREVIEW, FBXSDK_IMPLEMENTATION_MENTALRAY, FBXSDK_IMPLEMENTATION_CGFX, FBXSDK_IMPLEMENTATION_HLSL, FBXSDK_IMPLEMENTATION_OGS or FBXSDK_IMPLEMENTATION_NONE

See also:
  FbxImplementationFilter

Definition at line 50 of file fbximplementation.h.

`#include <fbximplementation.h>`

Inheritance diagram for FbxImplementation:
[legend]

List of all members.

## Protected Member Functions
virtual void | ConstructProperties (bool pForceSet)
| Optional property constructor override, automatically called by default constructor.
## Target Name.
FbxString | RenderName
## Shader Language and API descriptions.
FbxPropertyT< FbxString > | Language
| Shader Language.
FbxPropertyT< FbxString > | LanguageVersion
| Shader Language version.
FbxPropertyT< FbxString > | RenderAPI
| Render API.
FbxPropertyT< FbxString > | RenderAPIVersion
| Render API version.
## Binding description
FbxPropertyT< FbxString > | RootBindingName
| Name of root binding table.
FbxProperty | GetConstants () const
| Property to store the shader parameters(constants) values in this implementation.
FbxBindingTable * | AddNewTable (char const *pTargetName, char const *pTargetType)
| Add a new binding table to the table list.
FbxBindingTable const * | GetRootTable () const
| Retrieves a handle on the root binding table.
FbxBindingTable * | GetRootTable ()
| Retrieves a handle on the root binding table.
int | GetTableCount () const
| Gets the number of binding tables.
FbxBindingTable const * | GetTable (int pIndex) const
| Retrieves a handle on the (pIndex)th binding table.
FbxBindingTable * | GetTable (int pIndex)
| Retrieves a handle on the (pIndex)th binding table.
FbxBindingTable const * | GetTableByTargetName (char const *pName) const
| Returns the binding table that has the given target name.
FbxBindingTable * | GetTableByTargetName (char const *pName)
| Returns the binding table that has the given target name.
FbxBindingTable const * | GetTableByTargetType (char const *pTargetName) const
| Returns the binding table that has the given target type.
FbxBindingTable * | GetTableByTargetType (char const *pTargetName)
| Returns the binding table that has the given target type.
FbxBindingOperator * | AddNewBindingOperator (char const *pTargetName, char const *pFunctionName)
| Add a new binding operator to the operator list.
int | GetBindingOperatorCount () const
| Gets the number of binding operators.
FbxBindingOperator const * | GetOperatorByTargetName (char const *pTargetName) const
| Returns the binding operator that has the given name.
## Static values
static const char * | sLanguage
| Shader Language name.
static const char * | sLanguageVersion
| Shader Language version.
static const char * | sRenderAPI
| Shader render API.
static const char * | sRenderAPIVersion
| Shader render API version.
static const char * | sRootBindingName
| Name of root binding table.
static const char * | sConstants
| Name of property to store the shader parameters(constants) values in this implementation.
static const char * | sDefaultType
| default value for implementation type.
static const char * | sDefaultLanguage
| default value for shader language.
static const char * | sDefaultLanguageVersion
| default value for shader language version.
static const char * | sDefaultRenderAPI
| default value for shader render API.
static const char * | sDefaultRenderAPIVersion
| default value for shader render API version.
static const char * | sDefaultRootBindingName
| default value for root binding table name.

## Member Function Documentation

FbxProperty GetConstants | ( |  | ) | const

Search for all occurrences

Property to store the shader parameters(constants) values in this implementation.

FbxBindingTable* AddNewTable | ( | char const * | pTargetName,
|  | char const * | pTargetType
| ) |  |

Search for all occurrences

Add a new binding table to the table list.

Parameters:

  pTargetName | The target name for the binding table.
  pTargetType | The target type for the binding table.

Returns:
  the new binding table.

FbxBindingTable const* GetRootTable | ( |  | ) | const

Search for all occurrences

Retrieves a handle on the root binding table.

Returns:
  A const pointer to the root table or NULL if it does not exist.

FbxBindingTable* GetRootTable | ( |  | ) |

Search for all occurrences

Retrieves a handle on the root binding table.

Returns:
  A pointer to the root table or NULL if it does not exist.

int GetTableCount | ( |  | ) | const

Search for all occurrences

Gets the number of binding tables.

Returns:
  the number of binding tables.

FbxBindingTable const* GetTable | ( | int | pIndex | ) | const

Search for all occurrences

Retrieves a handle on the (pIndex)th binding table.

Parameters:

  pIndex | The index of the table to retrieve. Valid values are [ 0, GetTableCount() ).

Returns:
  A const pointer to the pIndex-th table or NULL if pIndex is out of range.

FbxBindingTable* GetTable | ( | int | pIndex | ) |

Search for all occurrences

Retrieves a handle on the (pIndex)th binding table.

Parameters:

  pIndex | The index of the table to retrieve. Valid values are [ 0, GetTableCount() ).

Returns:
  A const pointer to the pIndex-th table or NULL if pIndex is out of range.

FbxBindingTable const* GetTableByTargetName | ( | char const * | pName | ) | const

Search for all occurrences

Returns the binding table that has the given target name.

Parameters:

  pName | The target name of the table to look for.

Returns:
  A const pointer to the binding table with the given target name, or NULL if there is no such binding table.

FbxBindingTable* GetTableByTargetName | ( | char const * | pName | ) |

Search for all occurrences

Returns the binding table that has the given target name.

Parameters:

  pName | The target name of the table to look for.

Returns:
  A pointer to the binding table with the given target name, or NULL if there is no such binding table.

FbxBindingTable const* GetTableByTargetType | ( | char const * | pTargetName | ) | const

Search for all occurrences

Returns the binding table that has the given target type.

Parameters:

  pTargetType | The target type to look for.

Returns:
  A const pointer to the binding table with the given target type, or NULL if there is no such binding table.

FbxBindingTable* GetTableByTargetType | ( | char const * | pTargetName | ) |

Search for all occurrences

Returns the binding table that has the given target type.

Parameters:

  pTargetType | The target type to look for.

Returns:
  A pointer to the binding table with the given target type, or NULL if there is no such binding table.

FbxBindingOperator* AddNewBindingOperator | ( | char const * | pTargetName,
|  | char const * | pFunctionName
| ) |  |

Search for all occurrences

Add a new binding operator to the operator list.

Parameters:

  pTargetName | The target name for the binding operator.
  pFunctionName | The function name for the binding operator.

Returns:
  The new operator.

int GetBindingOperatorCount | ( |  | ) | const

Search for all occurrences

Gets the number of binding operators.

Returns:
  the number of binding operators.

FbxBindingOperator const* GetOperatorByTargetName | ( | char const * | pTargetName | ) | const

Search for all occurrences

Returns the binding operator that has the given name.

Parameters:

  pTargetName | The target name of the binding operator to look for.

Returns:
  A const pointer to the binding operator with the given name, or NULL if there is no such binding table.

virtual void ConstructProperties | ( | bool | pForceSet | ) | `[protected, virtual]`

Search for all occurrences

Optional property constructor override, automatically called by default constructor.

Parameters:

  pForceSet | If the property value must be set regardless of default value.

Remarks:
  If your object have properties, they must be initialized in this function.

Reimplemented from FbxObject.

## Member Data Documentation

FbxString RenderName

Search for all occurrences

Definition at line 59 of file fbximplementation.h.

FbxPropertyT<FbxString> Language

Search for all occurrences

Shader Language.

See also:
  FBXSDK_SHADING_LANGUAGE_HLSL, FBXSDK_SHADING_LANGUAGE_GLSL, FBXSDK_SHADING_LANGUAGE_CGFX and FBXSDK_SHADING_LANGUAGE_MRSL in conventions.h

Definition at line 70 of file fbximplementation.h.

FbxPropertyT<FbxString> LanguageVersion

Search for all occurrences

Shader Language version.

Definition at line 73 of file fbximplementation.h.

FbxPropertyT<FbxString> RenderAPI

Search for all occurrences

Render API.

See also:
  FBXSDK_SHADING_LANGUAGE_HLSL, FBXSDK_SHADING_LANGUAGE_GLSL, FBXSDK_SHADING_LANGUAGE_CGFX and FBXSDK_SHADING_LANGUAGE_MRSL in conventions.h

Definition at line 78 of file fbximplementation.h.

FbxPropertyT<FbxString> RenderAPIVersion

Search for all occurrences

Render API version.

Definition at line 81 of file fbximplementation.h.

FbxPropertyT<FbxString> RootBindingName

Search for all occurrences

Name of root binding table.

Definition at line 91 of file fbximplementation.h.

const char* sLanguage`[static]`

Search for all occurrences

Shader Language name.

See also:
  Language

Definition at line 184 of file fbximplementation.h.

const char* sLanguageVersion`[static]`

Search for all occurrences

Shader Language version.

See also:
  LanguageVersion

Definition at line 189 of file fbximplementation.h.

const char* sRenderAPI`[static]`

Search for all occurrences

Shader render API.

See also:
  RenderAPI

Definition at line 194 of file fbximplementation.h.

const char* sRenderAPIVersion`[static]`

Search for all occurrences

Shader render API version.

See also:
  RenderAPIVersion

Definition at line 199 of file fbximplementation.h.

const char* sRootBindingName`[static]`

Search for all occurrences

Name of root binding table.

See also:
  RootBindingName

Definition at line 204 of file fbximplementation.h.

const char* sConstants`[static]`

Search for all occurrences

Name of property to store the shader parameters(constants) values in this implementation.

See also:
  GetConstants

Definition at line 209 of file fbximplementation.h.

const char* sDefaultType`[static]`

Search for all occurrences

default value for implementation type.

Definition at line 212 of file fbximplementation.h.

const char* sDefaultLanguage`[static]`

Search for all occurrences

default value for shader language.

Definition at line 215 of file fbximplementation.h.

const char* sDefaultLanguageVersion`[static]`

Search for all occurrences

default value for shader language version.

Definition at line 218 of file fbximplementation.h.

const char* sDefaultRenderAPI`[static]`

Search for all occurrences

default value for shader render API.

Definition at line 221 of file fbximplementation.h.

const char* sDefaultRenderAPIVersion`[static]`

Search for all occurrences

default value for shader render API version.

Definition at line 224 of file fbximplementation.h.

const char* sDefaultRootBindingName`[static]`

Search for all occurrences

default value for root binding table name.

Definition at line 227 of file fbximplementation.h.

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

- fbxsdk/scene/shading/fbximplementation.h

FbxImplementation FbxImplementation FbxImplementation FbxImplementation FbxImplementation FbxImplementation FbxImplementation FbxImplementation FbxImplementation FbxImplementation
FbxImplementation FbxImplementation FbxImplementation FbxImplementation FbxImplementation FbxImplementation FbxImplementation FbxImplementation FbxImplementation FbxImplementation