All Frameworks Class Hierarchy This Framework Indexes Previous Next

DataExchangeKernelItf Interface CATIExchangeMaterialAndTextureProperty

Usage: you can freely reimplement this interface.

interface CATIExchangeMaterialAndTextureProperty

Interface to exchange material and texture information.
Role: This interface provides an XCAD acces to material and texture information that may be defined on an XCAD tessellated representation. If an implementer component of CATIExchangeTessellatedRepresentation wants to give access to material and texture information it must also implement this interface.
Available from CATIA V5R21.

See also:

Method Index

o GetFaceNbTextureCoordinates(void*,unsigned int&): Retrieves the number of texture coordinates arrays defined on a node.
o GetFaceTextureCoordinates(void*,unsigned int,int&,float**): Retrieves one texture coordinates array on a node.
o GetGlobalMaterialAndTexture(unsigned int,CATIExchangeMaterialAndTexture_var&): Retrieves one "global" material and texture description.
o GetGlobalNbMaterialAndTextures(unsigned int&): Retrieves the number of material and texture defined globaly on the geometry.
o GetNodeMaterialAndTexture(void*,unsigned int,CATIExchangeMaterialAndTexture_var&): Retrieves one material and texture description on a node.
o GetNodeNbMaterialAndTextures(void*,unsigned int&): Retrieves the number of material and texture defined on a node.

Methods

o GetFaceNbTextureCoordinates

public virtual GetFaceNbTextureCoordinates(	const	`iNodeID`,
		`oNbTextureCoordinates`)

Retrieves the number of texture coordinates arrays defined on a node.

Parameters:

iNodeID: the node's ID . Legal values: A valid Node ID as returned by CATIExchangeTessellatedRepresentation::GetChild() method.
The node type must be NOD_GP and the GP_TYPE must be one of GP_Face, GP_Plane, GP_Cylinder, GP_Cone or GP_Sphere.
oNbTextureCoordinates: the number of texture coordinates defined on the node.

Returns:

S_OK if everything is fine, E_INVALIDARG if the Node ID is invalid or it's type not NOD_GP or the GP type is not one expected, E_FAIL otherwise.

o GetFaceTextureCoordinates

public virtual GetFaceTextureCoordinates(	const	`iNodeID`,
		`iTextCoordIndex`,
		`oUVDim`,
		`oUVs`)

Retrieves one texture coordinates array on a node.

Parameters:

iNodeID: the node's ID . Legal values: A valid Node ID as returned by CATIExchangeTessellatedRepresentation::GetChild() method.
The node type must be NOD_GP and the GP_TYPE must be one of GP_Face, GP_Plane, GP_Cylinder, GP_Cone or GP_Sphere.
iTextCoordIndex: the index of the wanted texture coordinates array of the node. Legal values: From 0 to the number of texture coordinates array - 1.
oUVDim: The number of coordinates per vertex (1, 2 or 3)
oUVs: The array of texture coordinates.
It must NOT be deleted by the caller program.

Returns:

S_OK if everything is fine, E_INVALIDARG if the Node ID is invalid or it's type not NOD_GP or the GP type is not one expected, E_FAIL otherwise.

o GetGlobalMaterialAndTexture

public virtual GetGlobalMaterialAndTexture(		`iMaterialIndex`,
		`oMaterial`)

Retrieves one "global" material and texture description.

Parameters:

iMaterialIndex: the index of the wanted "global" material. Legal values: From 0 to the number of "global" material - 1.
oMaterial: the material description.

Returns:

S_OK if everything is fine, E_FAIL otherwise.

o GetGlobalNbMaterialAndTextures

public virtual GetGlobalNbMaterialAndTextures( oNbMaterials)

Retrieves the number of material and texture defined globaly on the geometry.

Parameters:

oNbMaterials: the number of "global" materials.

Returns:

S_OK if everything is fine, E_FAIL otherwise.

o GetNodeMaterialAndTexture

public virtual GetNodeMaterialAndTexture(	const	`iNodeID`,
		`iMaterialIndex`,
		`oMaterial`)

Retrieves one material and texture description on a node.

Parameters:

iNodeID: the node's ID . Legal values: A valid Node ID as returned by CATIExchangeTessellatedRepresentation::GetChild() method.
The node type must be neither NOD_ContainerNode or NOD_GP nor NOD_CoordinateSystem.
iMaterialIndex: the index of the wanted material of the node. Legal values: From 0 to the number of node material - 1.
oNbMaterials: the material description.

Returns:

S_OK if everything is fine, E_INVALIDARG if the Node ID is invalid or it's type is NOD_ContainerNode or NOD_GP or NOD_CoordinateSystem, E_FAIL otherwise.

o GetNodeNbMaterialAndTextures

public virtual GetNodeNbMaterialAndTextures(	const	`iNodeID`,
		`oNbMaterials`)

Retrieves the number of material and texture defined on a node.

Parameters:

iNodeID: the node's ID . Legal values: A valid Node ID as returned by CATIExchangeTessellatedRepresentation::GetChild() method.
The node type must be neither NOD_ContainerNode nor NOD_GP nor NOD_CoordinateSystem.
oNbMaterials: the number of materials defined on the node.

Returns:

S_OK if everything is fine, E_INVALIDARG if the Node ID is invalid or it's type is NOD_ContainerNode or NOD_GP or NOD_CoordinateSystem ,E_FAIL otherwise.

This object is included in the file: CATIExchangeMaterialAndTextureProperty.h
If needed, your Imakefile.mk should include the module: DataExchangeKernelItf