This reference page is linked to from the following overview topics: Referencing Media, Meshes, Materials and Textures, Textures, Layered Textures.
Detailed Description
This class describes image mapping on top of geometry.
- Note:
- To apply a texture to geometry, first connect the geometry to a FbxSurfaceMaterial object (e.g. FbxSurfaceLambert) and then connect one of its properties (e.g. Diffuse) to the FbxFileTexture object.
- Note:
- For some example code, see also the CreateTexture() function in the ExportScene03 of FBX SDK examples.
Definition at line 34 of file fbxfiletexture.h.
#include <fbxfiletexture.h>
Public Member Functions | |
| virtual FbxObject & | Copy (const FbxObject &pObject) |
| Copy an object content into this object. | |
| bool | operator== (FbxFileTexture const &pTexture) const |
| FbxString & | GetMediaName () |
| void | SetMediaName (char const *pMediaName) |
Protected Member Functions | |
| virtual void | Construct (const FbxFileTexture *pFrom) |
| virtual void | ConstructProperties (bool pForceSet) |
| Optional property constructor override, automatically called by default constructor. | |
| void | Init () |
| void | SyncVideoFileName (char const *pFileName) |
| void | SyncVideoRelativeFileName (char const *pFileName) |
Protected Attributes | |
| FbxString | mFileName |
| FbxString | mRelativeFileName |
| FbxString | mMediaName |
Texture Properties | |
| enum | EMaterialUse { eModelMaterial, eDefaultMaterial } |
Specify if texture uses model material. More... | |
| FbxPropertyT< FbxBool > | UseMaterial |
| This property handles the material use. | |
| FbxPropertyT< FbxBool > | UseMipMap |
| This property handles the Mipmap use. | |
| void | Reset () |
| Resets the default texture values. | |
| bool | SetFileName (char const *pName) |
| Sets the associated texture file. | |
| bool | SetRelativeFileName (char const *pName) |
| Sets the associated texture file. | |
| char const * | GetFileName () const |
| Returns the absolute texture file path. | |
| char const * | GetRelativeFileName () const |
| Returns the relative texture file path. | |
| void | SetMaterialUse (EMaterialUse pMaterialUse) |
| Sets the material use. | |
| EMaterialUse | GetMaterialUse () const |
| Returns the material use. | |
Member Enumeration Documentation
| enum EMaterialUse |
Specify if texture uses model material.
- Enumerator:
eModelMaterial eDefaultMaterial Texture uses model material.
Texture does not use model material.
Definition at line 86 of file fbxfiletexture.h.
Member Function Documentation
| void Reset | ( | ) | [virtual] |
Resets the default texture values.
- Remarks:
- The texture file name is not reset.
Reimplemented from FbxTexture.
| bool SetFileName | ( | char const * | pName | ) |
Sets the associated texture file.
- Parameters:
-
pName The absolute path of the texture file.
- Returns:
Trueif successful, returnsfalseotherwise.
- Remarks:
- The texture file name must be valid, you cannot leave the name empty.
| bool SetRelativeFileName | ( | char const * | pName | ) |
Sets the associated texture file.
- Parameters:
-
pName The relative path of the texture file.
- Returns:
Trueif successful, returnsfalseotherwise.
- Remarks:
- The texture file name must be valid.
| char const* GetFileName | ( | ) | const |
Returns the absolute texture file path.
- Returns:
- The absolute texture file path.
- Remarks:
- An empty string is returned if FbxFileTexture::SetFileName() has not been called before.
| char const* GetRelativeFileName | ( | ) | const |
Returns the relative texture file path.
- Returns:
- The relative texture file path.
- Remarks:
- An empty string is returned if FbxFileTexture::SetRelativeFileName() has not been called before.
| void SetMaterialUse | ( | EMaterialUse | pMaterialUse | ) |
Sets the material use.
- Parameters:
-
pMaterialUse Specify how texture uses model material.
| EMaterialUse GetMaterialUse | ( | ) | const |
Copy an object content into this object.
- Parameters:
-
pObject The source object to copy data from.
- Returns:
- Returns the destination object being modified by the source.
- Remarks:
- This function replace the assignment operator (operator=). It will copy all property values and the name. Connections are NOT copied.
Reimplemented from FbxTexture.
| bool operator== | ( | FbxFileTexture const & | pTexture | ) | const |
| FbxString& GetMediaName | ( | ) |
| void SetMediaName | ( | char const * | pMediaName | ) |
| virtual void Construct | ( | const FbxFileTexture * | pFrom | ) | [protected, virtual] |
| virtual void ConstructProperties | ( | bool | pForceSet | ) | [protected, virtual] |
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 FbxTexture.
| void Init | ( | ) | [protected] |
Reimplemented from FbxTexture.
| void SyncVideoFileName | ( | char const * | pFileName | ) | [protected] |
| void SyncVideoRelativeFileName | ( | char const * | pFileName | ) | [protected] |
Member Data Documentation
This property handles the material use.
Default value is false.
Definition at line 46 of file fbxfiletexture.h.
This property handles the Mipmap use.
Default value is false.
Definition at line 51 of file fbxfiletexture.h.
Definition at line 125 of file fbxfiletexture.h.
FbxString mRelativeFileName [protected] |
Definition at line 126 of file fbxfiletexture.h.
FbxString mMediaName [protected] |
Definition at line 127 of file fbxfiletexture.h.
The documentation for this class was generated from the following file:
- fbxsdk/scene/shading/fbxfiletexture.h
