This reference page is linked to from the following overview topics: FBX SDK 2012, Supported Scene Elements, FBX Scenes, Textures, Layered Textures, List of Python FBX classes.

Detailed Description

This class is the base class for textures, ie classes KFbxFileTexture, KFbxLayeredTexture and KFbxProceduralTexture.

It describes image mapping on top of a geometry.

Examples:: ExportDocument/main.cxx, ImportScene/DisplayMaterial.cxx, ImportScene/DisplayMesh.cxx, ImportScene/DisplayTexture.cxx, ImportScene/DisplayTexture.h, and Layers/main.cxx.

Definition at line 59 of file kfbxtexture.h.

#include <kfbxtexture.h>

Inheritance diagram for KFbxTexture:

[legend]

List of all members.

Public Member Functions
virtual KFbxObject &	Copy (const KFbxObject &pObject)
	Copy an object content into this object.
virtual bool	operator== (KFbxTexture const &pTexture) const
void	SetUVTranslation (KFbxVector2 &pT)
KFbxVector2 &	GetUVTranslation ()
void	SetUVScaling (KFbxVector2 &pS)
KFbxVector2 &	GetUVScaling ()
KString	GetTextureType ()
Protected Member Functions
	KFbxTexture (KFbxSdkManager &pManager, char const *pName)
virtual void	Construct (const KFbxTexture *pFrom)
virtual bool	ConstructProperties (bool pForceSet)
virtual bool	PropertyNotify (eFbxPropertyNotify pType, KFbxProperty *pProperty)
void	Init ()
Protected Attributes
int	mCropping [4]
EAlphaSource	mAlphaSource
EMappingType	mMappingType
EPlanarMappingNormal	mPlanarMappingNormal
KFbxVector2	mUVScaling
KFbxVector2	mUVTranslation
Static Protected Attributes
static KError	smError
Friends
class	KFbxLayerContainer
Texture Properties
enum	EUnifiedMappingType { eUMT_UV, eUMT_XY, eUMT_YZ, eUMT_XZ, eUMT_SPHERICAL, eUMT_CYLINDRICAL, eUMT_ENVIRONMENT, eUMT_PROJECTION, eUMT_BOX, eUMT_FACE, eUMT_NO_MAPPING }
	Internal enum for texture mapping types. More...
enum	ETextureUse6 { eTEXTURE_USE_6_STANDARD, eTEXTURE_USE_6_SPHERICAL_REFLEXION_MAP, eTEXTURE_USE_6_SPHERE_REFLEXION_MAP, eTEXTURE_USE_6_SHADOW_MAP, eTEXTURE_USE_6_LIGHT_MAP, eTEXTURE_USE_6_BUMP_NORMAL_MAP }
	Internal enum for texture usage. More...
enum	EWrapMode { eREPEAT, eCLAMP }
	Wrap modes. More...
enum	EBlendMode { eTRANSLUCENT, eADDITIVE, eMODULATE, eMODULATE2, eOVER }
	Blend modes. More...
enum	EAlignMode { eLEFT = 0, eRIGHT, eTOP, eBOTTOM }
	Align indices for cropping. More...
enum	ECoordinates { eU = 0, eV, eW }
	Texture coordinates. More...
enum	EAlphaSource { eNONE, eRGB_INTENSITY, eBLACK }
	Controls if the Alpha computation of the current texture comes from the Alpha channel, RGB Intensity channel, or if there is No Alpha. More...
enum	EMappingType { eNULL, ePLANAR, eSPHERICAL, eCYLINDRICAL, eBOX, eFACE, eUV, eENVIRONMENT }
	Texture mapping types. More...
enum	EPlanarMappingNormal { ePLANAR_NORMAL_X, ePLANAR_NORMAL_Y, ePLANAR_NORMAL_Z }
	Planar mapping normal orientations. More...
enum	ETextureUse { eSTANDARD, eSHADOW_MAP, eLIGHT_MAP, eSPHERICAL_REFLEXION_MAP, eSPHERE_REFLEXION_MAP, eBUMP_NORMAL_MAP }
	Texture uses. More...
KFbxTypedProperty< ETextureUse6 >	TextureTypeUse
	This property handles the use of textures.
KFbxTypedProperty< fbxDouble1 >	Alpha
	This property handles the default alpha value for textures.
KFbxTypedProperty < EUnifiedMappingType >	CurrentMappingType
	This property handles the texture mapping types.
KFbxTypedProperty< EWrapMode >	WrapModeU
	This property handles the texture wrap modes in U.
KFbxTypedProperty< EWrapMode >	WrapModeV
	This property handles the texture wrap modes in V.
KFbxTypedProperty< fbxBool1 >	UVSwap
	This property handles the swap UV flag.
KFbxTypedProperty< fbxBool1 >	PremultiplyAlpha
	This property handles the PremultiplyAlpha flag.
KFbxTypedProperty< fbxDouble3 >	Translation
	This property handles the default translation vector.
KFbxTypedProperty< fbxDouble3 >	Rotation
	This property handles the default rotation vector.
KFbxTypedProperty< fbxDouble3 >	Scaling
	This property handles the default scale vector.
KFbxTypedProperty< fbxDouble3 >	RotationPivot
	This property handles the rotation pivot vector.
KFbxTypedProperty< fbxDouble3 >	ScalingPivot
	This property handles the scaling pivot vector.
KFbxTypedProperty< EBlendMode >	CurrentTextureBlendMode
	This property handles the texture blend mode.
KFbxTypedProperty< fbxString >	UVSet
	This property handles the use of UV sets.
static const char *	sVectorSpace
	This property only used by Vector Displacement Texture so it is not added to KFbxTexture.
static const char *	sVectorSpaceWorld
static const char *	sVectorSpaceObject
static const char *	sVectorSpaceTangent
static const char *	sVectorEncoding
	This property only used by Vector Displacement Texture so it is not added to KFbxTexture.
static const char *	sVectorEncodingFP
static const char *	sVectorEncodingSE
virtual void	Reset ()
	Resets the default texture values.
void	SetSwapUV (bool pSwapUV)
	Sets the swap UV flag.
bool	GetSwapUV () const
	Returns the swap UV flag.
void	SetPremultiplyAlpha (bool pPremultiplyAlpha)
	Sets the PremultiplyAlpha flag.
bool	GetPremultiplyAlpha () const
	Returns the PremultiplyAlpha flag.
void	SetAlphaSource (EAlphaSource pAlphaSource)
	Sets the alpha source.
EAlphaSource	GetAlphaSource () const
	Returns the alpha source.
void	SetCropping (int pLeft, int pTop, int pRight, int pBottom)
	Sets cropping.
int	GetCroppingLeft () const
	Returns left cropping.
int	GetCroppingTop () const
	Returns top cropping.
int	GetCroppingRight () const
	Returns right cropping.
int	GetCroppingBottom () const
	Returns bottom cropping.
void	SetMappingType (EMappingType pMappingType)
	Sets the mapping type.
EMappingType	GetMappingType () const
	Returns the mapping type.
void	SetPlanarMappingNormal (EPlanarMappingNormal pPlanarMappingNormal)
	Sets the normal orientations for planar mapping.
EPlanarMappingNormal	GetPlanarMappingNormal () const
	Returns the normal orientations for planar mapping.
void	SetTextureUse (ETextureUse pTextureUse)
	Sets the texture use.
ETextureUse	GetTextureUse () const
	Returns the texture use.
void	SetWrapMode (EWrapMode pWrapU, EWrapMode pWrapV)
	Sets the U and V wrap mode.
EWrapMode	GetWrapModeU () const
	Returns the U wrap mode.
EWrapMode	GetWrapModeV () const
	Returns the V wrap mode.
void	SetBlendMode (EBlendMode pBlendMode)
	Sets the blend mode.
EBlendMode	GetBlendMode () const
	Returns the blend mode.
Default Values Management By Vectors
This set of functions provides direct access to the default values in vector base.
void	SetDefaultT (const KFbxVector4 &pT)
	Sets the default translation vector.
KFbxVector4 &	GetDefaultT (KFbxVector4 &pT) const
	Returns the default translation vector.
void	SetDefaultR (const KFbxVector4 &pR)
	Sets the default rotation vector.
KFbxVector4 &	GetDefaultR (KFbxVector4 &pR) const
	Returns the default rotation vector.
void	SetDefaultS (const KFbxVector4 &pS)
	Sets the default scale vector.
KFbxVector4 &	GetDefaultS (KFbxVector4 &pS) const
	Returns the default scale vector.
Default Alpha Value
void	SetDefaultAlpha (double pAlpha)
	Sets the default alpha.
double	GetDefaultAlpha () const
	Returns the default alpha.
Default Values Management By Numbers
This set of functions provides direct access to the default values in number base.U, V and W coordinates are mapped to the X, Y and Z coordinates of the default vectors found in the "Default Values By Vector" section.
void	SetTranslation (double pU, double pV)
	Sets translation.
double	GetTranslationU () const
	Returns translation applied to the texture width.
double	GetTranslationV () const
	Returns translation applied to the texture height.
void	SetRotation (double pU, double pV, double pW=0.0)
	Sets rotation.
double	GetRotationU () const
	Returns the texture rotation around the U axis in degrees.
double	GetRotationV () const
	Returns the texture rotation around the V axis in degrees.
double	GetRotationW () const
	Returns the texture rotation around the W axis in degrees.
void	SetScale (double pU, double pV)
	Sets scale.
double	GetScaleU () const
	Returns scale applied to the texture width.
double	GetScaleV () const
	Returns scale applied to the texture height.

Member Enumeration Documentation

enum EUnifiedMappingType

Search for all occurrences

Internal enum for texture mapping types.

Includes mapping types and planar mapping normal orientations. Use SetMappingType(), GetMappingType(), SetPlanarMappingNormal() and GetPlanarMappingNormal() to access these values.

Enumerator:

eUMT_UV	Maps to EMappingType::eUV. Search for all occurrences
eUMT_XY	Maps to EMappingType::ePLANAR and EPlanarMappingNormal::ePLANAR_NORMAL_Z. Search for all occurrences
eUMT_YZ	Maps to EMappingType::ePLANAR and EPlanarMappingNormal::ePLANAR_NORMAL_X. Search for all occurrences
eUMT_XZ	Maps to EMappingType::ePLANAR and EPlanarMappingNormal::ePLANAR_NORMAL_Y. Search for all occurrences
eUMT_SPHERICAL	Maps to EMappingType::eSPHERICAL. Search for all occurrences
eUMT_CYLINDRICAL	Maps to EMappingType::eCYLINDRICAL. Search for all occurrences
eUMT_ENVIRONMENT	Maps to EMappingType::eENVIRONMENT. Search for all occurrences
eUMT_PROJECTION	Unused. Search for all occurrences
eUMT_BOX	Maps to EMappingType::eBOX. Deprecated. Search for all occurrences
eUMT_FACE	Maps to EMappingType::eFACE. Deprecated. Search for all occurrences
eUMT_NO_MAPPING	Maps to EMappingType::eNULL. Search for all occurrences

Definition at line 74 of file kfbxtexture.h.

        { 
            eUMT_UV, 
            eUMT_XY, 
            eUMT_YZ, 
            eUMT_XZ, 
            eUMT_SPHERICAL,
            eUMT_CYLINDRICAL,
            eUMT_ENVIRONMENT,
            eUMT_PROJECTION,
            eUMT_BOX, // deprecated
            eUMT_FACE, // deprecated
            eUMT_NO_MAPPING,
        } EUnifiedMappingType;

enum ETextureUse6

Search for all occurrences

Internal enum for texture usage.

For example, the texture might be used as a standard texture, as a shadow map, as a bump map, etc. Use SetTextureUse() and GetTextureUse() to access these values.

Enumerator:

eTEXTURE_USE_6_STANDARD	Maps to ETextureUse::eSTANDARD. Search for all occurrences
eTEXTURE_USE_6_SPHERICAL_REFLEXION_MAP	Maps to ETextureUse::eSPHERICAL_REFLEXION_MAP. Search for all occurrences
eTEXTURE_USE_6_SPHERE_REFLEXION_MAP	Maps to ETextureUse::eSPHERE_REFLEXION_MAP. Search for all occurrences
eTEXTURE_USE_6_SHADOW_MAP	Maps to ETextureUse::eSHADOW_MAP. Search for all occurrences
eTEXTURE_USE_6_LIGHT_MAP	Maps to ETextureUse::eLIGHT_MAP. Search for all occurrences
eTEXTURE_USE_6_BUMP_NORMAL_MAP	Maps to ETextureUse::eBUMP_NORMAL_MAP. Search for all occurrences

Definition at line 105 of file kfbxtexture.h.

        {
            eTEXTURE_USE_6_STANDARD,
            eTEXTURE_USE_6_SPHERICAL_REFLEXION_MAP,
            eTEXTURE_USE_6_SPHERE_REFLEXION_MAP,
            eTEXTURE_USE_6_SHADOW_MAP,
            eTEXTURE_USE_6_LIGHT_MAP,
            eTEXTURE_USE_6_BUMP_NORMAL_MAP
        } ETextureUse6;

enum EWrapMode

Search for all occurrences

Wrap modes.

Use SetWrapMode(), GetWrapModeU() and GetWrapModeV() to access these values.

Enumerator:

eREPEAT	Apply the texture over and over on the model's surface until the model is covered. This is the default setting. Search for all occurrences
eCLAMP	Apply the texture to a model only once, using the color at the ends of the texture as the "filter". Search for all occurrences

Definition at line 124 of file kfbxtexture.h.

        {
            eREPEAT,
            eCLAMP
        } EWrapMode;

enum EBlendMode

Search for all occurrences

Blend modes.

Enumerator:

eTRANSLUCENT	The texture is transparent, depending on the Alpha settings. Search for all occurrences
eADDITIVE	The color of the texture is added to the previous texture. Search for all occurrences
eMODULATE	The color value of the texture is multiplied by the color values of all previous layers of texture. Search for all occurrences
eMODULATE2	The color value of the texture is multiplied by two and then multiplied by the color values of all previous layers of texture. Search for all occurrences
eOVER	The texture is opaque. Search for all occurrences

Reimplemented in KFbxLayeredTexture.

Definition at line 134 of file kfbxtexture.h.

        {
            eTRANSLUCENT,
            eADDITIVE,
            eMODULATE,
            eMODULATE2,
            eOVER
        } EBlendMode;

enum EAlignMode

Search for all occurrences

Align indices for cropping.

Enumerator:

eLEFT	Left cropping. Search for all occurrences
eRIGHT	Right cropping. Search for all occurrences
eTOP	Top cropping. Search for all occurrences
eBOTTOM	Bottom cropping. Search for all occurrences

Definition at line 150 of file kfbxtexture.h.

        {
            eLEFT = 0,
            eRIGHT,
            eTOP,
            eBOTTOM
        } EAlignMode;

enum ECoordinates

Search for all occurrences

Texture coordinates.

Enumerator:

eU	U axis. Search for all occurrences
eV	V axis. Search for all occurrences
eW	W axis. Search for all occurrences

Definition at line 164 of file kfbxtexture.h.

        {
            eU = 0,
            eV,
            eW
        } ECoordinates;

enum EAlphaSource

Search for all occurrences

Controls if the Alpha computation of the current texture comes from the Alpha channel, RGB Intensity channel, or if there is No Alpha.

Enumerator:

eNONE	No Alpha. Search for all occurrences
eRGB_INTENSITY	RGB Intensity (computed). Search for all occurrences
eBLACK	Alpha channel. Black is 100% transparency, white is opaque. Search for all occurrences

Definition at line 303 of file kfbxtexture.h.

    { 
        eNONE, 
        eRGB_INTENSITY, 
        eBLACK 
    } EAlphaSource;

enum EMappingType

Search for all occurrences

Texture mapping types.

Enumerator:

eNULL	No texture mapping defined. Search for all occurrences
ePLANAR	Apply texture to the model viewed as a plane. Search for all occurrences
eSPHERICAL	Wrap texture around the model as if it was a sphere. Search for all occurrences
eCYLINDRICAL	Wrap texture around the model as if it was a cylinder. Search for all occurrences
eBOX	Wrap texture around the model as if it was a box. Search for all occurrences
eFACE	Apply texture to the model viewed as a face. Search for all occurrences
eUV	Apply texture to the model according to UVs. Search for all occurrences
eENVIRONMENT	Texture is an environment map. Search for all occurrences

Definition at line 356 of file kfbxtexture.h.

    { 
        eNULL, 
        ePLANAR, 
        eSPHERICAL, 
        eCYLINDRICAL, 
        eBOX, 
        eFACE,
        eUV,
        eENVIRONMENT
    } EMappingType;

enum EPlanarMappingNormal

Search for all occurrences

Planar mapping normal orientations.

Enumerator:

ePLANAR_NORMAL_X	Normals are in the direction of the X axis, mapping plan is in the YZ axis. Search for all occurrences
ePLANAR_NORMAL_Y	Normals are in the direction of the Y axis, mapping plan is in the XZ axis. Search for all occurrences
ePLANAR_NORMAL_Z	Normals are in the direction of the Z axis, mapping plan is in the XY axis. Search for all occurrences

Definition at line 388 of file kfbxtexture.h.

    { 
        ePLANAR_NORMAL_X, 
        ePLANAR_NORMAL_Y, 
        ePLANAR_NORMAL_Z 
    } EPlanarMappingNormal;

enum ETextureUse

Search for all occurrences

Texture uses.

Enumerator:

eSTANDARD	Standard texture use (ex. image) Search for all occurrences
eSHADOW_MAP	Shadow map. Search for all occurrences
eLIGHT_MAP	Light map. Search for all occurrences
eSPHERICAL_REFLEXION_MAP	Spherical reflection map: Object reflects the contents of the scene. Search for all occurrences
eSPHERE_REFLEXION_MAP	Sphere reflection map: Object reflects the contents of the scene from only one point of view. Search for all occurrences
eBUMP_NORMAL_MAP	Bump map: Texture contains two direction vectors, that are used to convey relief in a texture. Search for all occurrences

Definition at line 410 of file kfbxtexture.h.

    {
        eSTANDARD,
        eSHADOW_MAP,
        eLIGHT_MAP,
        eSPHERICAL_REFLEXION_MAP,
        eSPHERE_REFLEXION_MAP,
        eBUMP_NORMAL_MAP
    } ETextureUse;

Constructor & Destructor Documentation

KFbxTexture	(	KFbxSdkManager &	pManager,
		char const *	pName
	)		`[protected]`

Member Function Documentation

virtual void Reset ( ) [virtual]

Search for all occurrences

Resets the default texture values.

Reimplemented in KFbxFileTexture, and KFbxProceduralTexture.

void SetSwapUV ( bool pSwapUV )

Search for all occurrences

Sets the swap UV flag.

Parameters:

pSwapUV Set to true if the swap UV flag is enabled.

Remarks:: If the swap UV flag is enabled, the texture's width and height are swapped.

Examples:: ExportDocument/main.cxx, ExportScene02/main.cxx, ExportScene03/main.cxx, Layers/main.cxx, and UIExamples/CubeCreator/SDK_Utility.cxx.

bool GetSwapUV ( ) const

Search for all occurrences

Returns the swap UV flag.

Returns:: True if the swap UV flag is enabled.

Remarks:: If the swap UV flag is enabled, the texture's width and height are swapped.

Examples:: ImportScene/DisplayTexture.cxx.

void SetPremultiplyAlpha ( bool pPremultiplyAlpha )

Search for all occurrences

Sets the PremultiplyAlpha flag.

Parameters:

pPremultiplyAlpha Set to true if the method of storing alpha is PremultiplyAlpha.

Remarks:: If PremultiplyAlpha flag is true, the R, G, and B components you store have already been multiplied in with the alpha.

bool GetPremultiplyAlpha ( ) const

Search for all occurrences

Returns the PremultiplyAlpha flag.

Returns:: True if the method of storing alpha is PremultiplyAlpha.

Remarks:: If PremultiplyAlpha flag is true, the R, G, and B components you store have already been multiplied in with the alpha.

void SetAlphaSource ( EAlphaSource pAlphaSource )

Search for all occurrences

Sets the alpha source.

Parameters:

pAlphaSource The alpha source identifier.

Examples:: ExportDocument/main.cxx.

EAlphaSource GetAlphaSource ( ) const

Search for all occurrences

Returns the alpha source.

Returns:: The alpha source identifier for this texture.

Examples:: ImportScene/DisplayTexture.cxx.

void SetCropping	(	int	pLeft,
		int	pTop,
		int	pRight,
		int	pBottom
	)

Search for all occurrences

Sets cropping.

Parameters:

pLeft	Left cropping value.
pTop	Top cropping value.
pRight	Right cropping value.
pBottom	Bottom cropping value.

Remarks:: The defined rectangle is not checked for invalid values. The caller must verify that the rectangle is meaningful for this texture.

int GetCroppingLeft ( ) const

Search for all occurrences

Returns left cropping.

Returns:: The left side of the cropping rectangle.

Examples:: ImportScene/DisplayTexture.cxx.

int GetCroppingTop ( ) const

Search for all occurrences

Returns top cropping.

Returns:: The top side of the cropping rectangle.

Examples:: ImportScene/DisplayTexture.cxx.

int GetCroppingRight ( ) const

Search for all occurrences

Returns right cropping.

Returns:: The right side of the cropping rectangle.

Examples:: ImportScene/DisplayTexture.cxx.

int GetCroppingBottom ( ) const

Search for all occurrences

Returns bottom cropping.

Returns:: The bottom side of the cropping rectangle.

Examples:: ImportScene/DisplayTexture.cxx.

void SetMappingType ( EMappingType pMappingType )

Search for all occurrences

Sets the mapping type.

Parameters:

pMappingType The mapping type identifier.

Examples:: ExportDocument/main.cxx, ExportScene02/main.cxx, ExportScene03/main.cxx, Layers/main.cxx, and UIExamples/CubeCreator/SDK_Utility.cxx.

EMappingType GetMappingType ( ) const

Search for all occurrences

Returns the mapping type.

Returns:: The mapping type identifier.

Examples:: ImportScene/DisplayTexture.cxx.

void SetPlanarMappingNormal ( EPlanarMappingNormal pPlanarMappingNormal )

Search for all occurrences

Sets the normal orientations for planar mapping.

Parameters:

pPlanarMappingNormal The identifier for planar mapping normal orientation.

EPlanarMappingNormal GetPlanarMappingNormal ( ) const

Search for all occurrences

Returns the normal orientations for planar mapping.

Returns:: The identifier for planar mapping normal orientation.

Examples:: ImportScene/DisplayTexture.cxx.

void SetTextureUse ( ETextureUse pTextureUse )

Search for all occurrences

Sets the texture use.

Parameters:

pTextureUse The texture use identifier.

Examples:: ExportDocument/main.cxx, ExportScene02/main.cxx, ExportScene03/main.cxx, Layers/main.cxx, and UIExamples/CubeCreator/SDK_Utility.cxx.

ETextureUse GetTextureUse ( ) const

Search for all occurrences

Returns the texture use.

Returns:: The texture use identifier.

Examples:: ImportScene/DisplayTexture.cxx.

void SetWrapMode	(	EWrapMode	pWrapU,
		EWrapMode	pWrapV
	)

Search for all occurrences

Sets the U and V wrap mode.

Parameters:

pWrapU	Wrap mode identifier.
pWrapV	Wrap mode identifier.

EWrapMode GetWrapModeU ( ) const

Search for all occurrences

Returns the U wrap mode.

Returns:: U wrap mode identifier.

EWrapMode GetWrapModeV ( ) const

Search for all occurrences

Returns the V wrap mode.

Returns:: V wrap mode identifier.

void SetBlendMode ( EBlendMode pBlendMode )

Search for all occurrences

Sets the blend mode.

Parameters:

pBlendMode Blend mode identifier.

EBlendMode GetBlendMode ( ) const

Search for all occurrences

Returns the blend mode.

Returns:: Blend mode identifier.

void SetDefaultT ( const KFbxVector4 & pT ) [inline]

Search for all occurrences

Sets the default translation vector.

Parameters:

pT The first element is the U translation applied to the texture. A displacement of one unit is equal to the texture width after the U scaling is applied. The second element is the V translation applied to the texture. A displacement of one unit is equal to the texture height after the V scaling is applied. The third and fourth elements have no effect on texture translation.

Definition at line 481 of file kfbxtexture.h.

{ Translation.Set( pT ); }

KFbxVector4& GetDefaultT ( KFbxVector4 & pT ) const

Search for all occurrences

Returns the default translation vector.

Parameters:

pT The first element is the U translation applied to the texture. A displacement of one unit is equal to the texture width after the U scaling is applied. The second element is the V translation applied to the texture. A displacement of one unit is equal to the texture height after the V scaling is applied. The third and fourth elements have no effect on texture translation.

Returns:: The input parameter completed with appropriate data.

void SetDefaultR ( const KFbxVector4 & pR ) [inline]

Search for all occurrences

Sets the default rotation vector.

Parameters:

pR	The first element is the texture rotation around the U axis in degrees. The second element is the texture rotation around the V axis in degrees. The third element is the texture rotation around the W axis in degrees.

Remarks:: The W axis is oriented toward the result of the vector product of the U and V axes that is W = U x V.

Definition at line 503 of file kfbxtexture.h.

{ Rotation.Set( fbxDouble3(pR[0],pR[1],pR[2]) ); }

KFbxVector4& GetDefaultR ( KFbxVector4 & pR ) const

Search for all occurrences

Returns the default rotation vector.

Parameters:

pR	First element is the texture rotation around the U axis in degrees. Second element is the texture rotation around the V axis in degrees. Third element is the texture rotation around the W axis in degrees.

Returns:: Input parameter filled with appropriate data.

Remarks:: The W axis is oriented towards the result of the vector product of the U axis and V axis i.e. W = U x V.

void SetDefaultS ( const KFbxVector4 & pS ) [inline]

Search for all occurrences

Sets the default scale vector.

Parameters:

pS	The first element is scale applied to the texture width. The second element is scale applied to the texture height. The third and fourth elements have no effect on the texture.

Remarks:: A scale value less than 1 stretches the texture. A scale value greater than 1 compresses the texture.

Definition at line 523 of file kfbxtexture.h.

{ Scaling.Set( fbxDouble3(pS[0],pS[1],pS[2]) ); }

KFbxVector4& GetDefaultS ( KFbxVector4 & pS ) const

Search for all occurrences

Returns the default scale vector.

Parameters:

pS	The first element is scale applied to the texture width. The second element is scale applied to the texture height. The third and fourth elements have no effect on the texture.

Remarks:: A scale value less than 1 stretches the texture. A scale value greater than 1 compresses the texture.

void SetDefaultAlpha ( double pAlpha )

Search for all occurrences

Sets the default alpha.

Parameters:

pAlpha A value on a scale from 0 to 1, with 0 being transparent.

double GetDefaultAlpha ( ) const

Search for all occurrences

Returns the default alpha.

Returns:: A value on a scale from 0 to 1, with 0 being transparent.

Examples:: ImportScene/DisplayTexture.cxx.

void SetTranslation	(	double	pU,
		double	pV
	)

Search for all occurrences

Sets translation.

Parameters:

pU	Horizontal translation applied to a texture. A displacement of one unit is equal to the texture's width after applying U scaling.
pV	Vertical translation applied to a texture. A displacement of one unit is equal to the texture's height after applying V scaling.

Examples:: ExportDocument/main.cxx, ExportScene02/main.cxx, ExportScene03/main.cxx, Layers/main.cxx, and UIExamples/CubeCreator/SDK_Utility.cxx.

double GetTranslationU ( ) const

Search for all occurrences

Returns translation applied to the texture width.

Remarks:: A displacement of one unit is equal to the texture's width after applying U scaling.

Examples:: ImportScene/DisplayTexture.cxx.

double GetTranslationV ( ) const

Search for all occurrences

Returns translation applied to the texture height.

Remarks:: A displacement of one unit is equal to the texture's height after applying V scaling.

Examples:: ImportScene/DisplayTexture.cxx.

void SetRotation	(	double	pU,
		double	pV,
		double	pW = `0.0`
	)

Search for all occurrences

Sets rotation.

Parameters:

pU	Texture rotation around the U axis in degrees.
pV	Texture rotation around the V axis in degrees.
pW	Texture rotation around the W axis in degrees.

Remarks:: The W axis is oriented toward the result of the vector product of the U and V axes that is W = U x V.

Examples:: ExportDocument/main.cxx, ExportScene02/main.cxx, ExportScene03/main.cxx, Layers/main.cxx, and UIExamples/CubeCreator/SDK_Utility.cxx.

double GetRotationU ( ) const

Search for all occurrences

Returns the texture rotation around the U axis in degrees.

Examples:: ImportScene/DisplayTexture.cxx.

double GetRotationV ( ) const

Search for all occurrences

Returns the texture rotation around the V axis in degrees.

Examples:: ImportScene/DisplayTexture.cxx.

double GetRotationW ( ) const

Search for all occurrences

Returns the texture rotation around the W axis in degrees.

Examples:: ImportScene/DisplayTexture.cxx.

void SetScale	(	double	pU,
		double	pV
	)

Search for all occurrences

Sets scale.

Parameters:

pU	Scale applied to the texture width.
pV	Scale applied to the texture height.

Remarks:: A scale value less than 1 stretches the texture. A scale value greater than 1 compresses the texture.

Examples:: ExportDocument/main.cxx, ExportScene02/main.cxx, ExportScene03/main.cxx, Layers/main.cxx, and UIExamples/CubeCreator/SDK_Utility.cxx.

double GetScaleU ( ) const

Search for all occurrences

Returns scale applied to the texture width.

Remarks:: A scale value less than 1 stretches the texture. A scale value greater than 1 compresses the texture.

Examples:: ImportScene/DisplayTexture.cxx.

double GetScaleV ( ) const

Search for all occurrences

Returns scale applied to the texture height.

Remarks:: A scale value less than 1 stretches the texture. A scale value greater than 1 compresses the texture.

Examples:: ImportScene/DisplayTexture.cxx.

virtual KFbxObject& Copy ( const KFbxObject & pObject ) [virtual]

Search for all occurrences

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 KFbxObject.

Reimplemented in KFbxFileTexture, and KFbxProceduralTexture.

virtual bool operator== ( KFbxTexture const & pTexture ) const [virtual]

void SetUVTranslation ( KFbxVector2 & pT )

Search for all occurrences

KFbxVector2& GetUVTranslation ( )

Search for all occurrences

void SetUVScaling ( KFbxVector2 & pS )

Search for all occurrences

KFbxVector2& GetUVScaling ( )

Search for all occurrences

KString GetTextureType ( )

Search for all occurrences

virtual void Construct ( const KFbxTexture * pFrom ) [protected, virtual]

Search for all occurrences

virtual bool ConstructProperties ( bool pForceSet ) [protected, virtual]

Search for all occurrences

Reimplemented from KFbxObject.

Reimplemented in KFbxFileTexture, and KFbxProceduralTexture.

virtual bool PropertyNotify	(	eFbxPropertyNotify	pType,
		KFbxProperty *	pProperty
	)		`[protected, virtual]`

Search for all occurrences

Reimplemented from KFbxObject.

void Init ( ) [protected]

Search for all occurrences

Reimplemented in KFbxFileTexture, and KFbxProceduralTexture.

Friends And Related Function Documentation

friend class KFbxLayerContainer [friend]

Search for all occurrences

Reimplemented in KFbxFileTexture.

Definition at line 663 of file kfbxtexture.h.

Member Data Documentation

KFbxTypedProperty<ETextureUse6> TextureTypeUse

Search for all occurrences

This property handles the use of textures.

Default value is eTEXTURE_USE_6_STANDARD.

Definition at line 179 of file kfbxtexture.h.

KFbxTypedProperty<fbxDouble1> Alpha

Search for all occurrences

This property handles the default alpha value for textures.

Default value is 1.0

Definition at line 184 of file kfbxtexture.h.

KFbxTypedProperty<EUnifiedMappingType> CurrentMappingType

Search for all occurrences

This property handles the texture mapping types.

Default value is eUMT_UV.

Definition at line 192 of file kfbxtexture.h.

KFbxTypedProperty<EWrapMode> WrapModeU

Search for all occurrences

This property handles the texture wrap modes in U.

Default value is eREPEAT.

Definition at line 197 of file kfbxtexture.h.

KFbxTypedProperty<EWrapMode> WrapModeV

Search for all occurrences

This property handles the texture wrap modes in V.

Default value is eREPEAT.

Definition at line 202 of file kfbxtexture.h.

KFbxTypedProperty<fbxBool1> UVSwap

Search for all occurrences

This property handles the swap UV flag.

If swap UV flag is enabled, the texture's width and height are swapped. Default value is false.

Definition at line 208 of file kfbxtexture.h.

KFbxTypedProperty<fbxBool1> PremultiplyAlpha

Search for all occurrences

This property handles the PremultiplyAlpha flag.

If PremultiplyAlpha flag is true, the R, G, and B components you store have already been multiplied in with the alpha. Default value is true.

Definition at line 214 of file kfbxtexture.h.

KFbxTypedProperty<fbxDouble3> Translation

Search for all occurrences

This property handles the default translation vector.

Default value is fbxDouble3(0.0,0.0,0.0).

Definition at line 221 of file kfbxtexture.h.

KFbxTypedProperty<fbxDouble3> Rotation

Search for all occurrences

This property handles the default rotation vector.

Default value is fbxDouble3(0.0,0.0,0.0).

Definition at line 226 of file kfbxtexture.h.

KFbxTypedProperty<fbxDouble3> Scaling

Search for all occurrences

This property handles the default scale vector.

Default value is fbxDouble3(1.0,1.0,1.0).

Definition at line 231 of file kfbxtexture.h.

KFbxTypedProperty<fbxDouble3> RotationPivot

Search for all occurrences

This property handles the rotation pivot vector.

Default value is fbxDouble3(0.0,0.0,0.0).

Definition at line 236 of file kfbxtexture.h.

KFbxTypedProperty<fbxDouble3> ScalingPivot

Search for all occurrences

This property handles the scaling pivot vector.

Default value is fbxDouble3(0.0,0.0,0.0).

Definition at line 241 of file kfbxtexture.h.

KFbxTypedProperty<EBlendMode> CurrentTextureBlendMode

Search for all occurrences

This property handles the texture blend mode.

Default value is eADDITIVE.

Definition at line 247 of file kfbxtexture.h.

KFbxTypedProperty<fbxString> UVSet

Search for all occurrences

This property handles the use of UV sets.

Default value is default.

Definition at line 253 of file kfbxtexture.h.

const char* sVectorSpace [static]

Search for all occurrences

This property only used by Vector Displacement Texture so it is not added to KFbxTexture.

It is a dynamic enum property which has values : "World", "Object" and "Tangent" Default value is "Object".

Definition at line 259 of file kfbxtexture.h.

const char* sVectorSpaceWorld [static]

Search for all occurrences

Definition at line 260 of file kfbxtexture.h.

const char* sVectorSpaceObject [static]

Search for all occurrences

Definition at line 261 of file kfbxtexture.h.

const char* sVectorSpaceTangent [static]

Search for all occurrences

Definition at line 262 of file kfbxtexture.h.

const char* sVectorEncoding [static]

Search for all occurrences

This property only used by Vector Displacement Texture so it is not added to KFbxTexture.

It is a dynamic enum property which has values : "Floating-point Absolute" and "Signed Encoding" Default value is "Floating-point Absolute".

Definition at line 268 of file kfbxtexture.h.

const char* sVectorEncodingFP [static]

Search for all occurrences

Definition at line 269 of file kfbxtexture.h.

const char* sVectorEncodingSE [static]

Search for all occurrences

Definition at line 270 of file kfbxtexture.h.

int mCropping[4] [protected]

Search for all occurrences

Definition at line 650 of file kfbxtexture.h.

EAlphaSource mAlphaSource [protected]

Search for all occurrences

Definition at line 652 of file kfbxtexture.h.

EMappingType mMappingType [protected]

Search for all occurrences

Definition at line 653 of file kfbxtexture.h.

EPlanarMappingNormal mPlanarMappingNormal [protected]

Search for all occurrences

Definition at line 654 of file kfbxtexture.h.

KError smError [static, protected]

Search for all occurrences

Definition at line 655 of file kfbxtexture.h.

KFbxVector2 mUVScaling [protected]

Search for all occurrences

Definition at line 660 of file kfbxtexture.h.

KFbxVector2 mUVTranslation [protected]

Search for all occurrences

Definition at line 661 of file kfbxtexture.h.

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

fbxfilesdk/kfbxplugins/kfbxtexture.h

KFbxTexture Class Reference

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Texture Properties

Default Values Management By Vectors

Default Alpha Value

Default Values Management By Numbers

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation