OdGiMapper Class Reference

#include <GiMaterial.h>

Public Types
enum	Projection {   kInheritProjection = 0 , kPlanar = 1 , kBox = 2 , kCylinder = 3 ,   kSphere = 4 , kDgnParametric = 0x32 , kDgnPlanar = 0x33 , kDgnCylinder = 0x34 ,   kDgnCylinderCapped = 0x35 , kDgnSphere = 0x36 }
enum	Tiling {   kInheritTiling = 0 , kTile = 1 , kCrop = 2 , kClamp = 3 ,   kMirror = 4 }
enum	AutoTransform { kInheritAutoTransform = 0x0 , kNone = 0x1 , kObject = 0x2 , kModel = 0x4 }

Public Member Functions
	OdGiMapper ()
	OdGiMapper (const OdGiMapper &mapper)
OdGiMapper &	operator= (const OdGiMapper &mapper)
bool	operator== (const OdGiMapper &mapper) const
bool	operator!= (const OdGiMapper &mapper) const
void	setProjection (Projection projection)
void	setUTiling (Tiling tiling)
void	setVTiling (Tiling tiling)
void	setAutoTransform (AutoTransform autoTransform)
OdGeMatrix3d &	transform ()
Projection	projection () const
Tiling	uTiling () const
Tiling	vTiling () const
AutoTransform	autoTransform () const
const OdGeMatrix3d &	transform () const
void	setTransform (const OdGeMatrix3d &tm)

Static Public Attributes
static ODGI_EXPORT_STATIC const OdGiMapper	kIdentity

Detailed Description

This class implements mappers.

Remarks

Mappers determine how an OdGiMaterialMap is mapped to an object surface.

See also

TD_Gi

<group OdGi_Classes>

Definition at line 1122 of file GiMaterial.h.

Member Enumeration Documentation

AutoTransform

enum OdGiMapper::AutoTransform

Specifies the automatic transform mode.

Enumerator
kInheritAutoTransform
kNone
kObject
kModel

Definition at line 1159 of file GiMaterial.h.

Projection

enum OdGiMapper::Projection

Specifies the mapping projection.

Enumerator
kInheritProjection
kPlanar
kBox
kCylinder
kSphere
kDgnParametric
kDgnPlanar
kDgnCylinder
kDgnCylinderCapped
kDgnSphere

Definition at line 1128 of file GiMaterial.h.

Tiling

enum OdGiMapper::Tiling

Specifies the mapper's tiling method.

Enumerator
kInheritTiling
kTile
kCrop
kClamp
kMirror

Definition at line 1147 of file GiMaterial.h.

Constructor & Destructor Documentation

OdGiMapper() [1/2]

OdGiMapper::OdGiMapper ( )

inline

Definition at line 1169 of file GiMaterial.h.

OdGiMapper() [2/2]

OdGiMapper::OdGiMapper ( const OdGiMapper &  mapper )

inline

Definition at line 1647 of file GiMaterial.h.

Member Function Documentation

autoTransform()

OdGiMapper::AutoTransform OdGiMapper::autoTransform ( ) const

inline

Returns the type of automatic transform for this Mapper object.

Remarks

autoTransform() returns a combination of one or more of the following:

Value Description kInheritAutoTransform 0x0 Inherits automatic transform from the current material's mapper. kNone 0x1 No automatic transform. kObject 0x2 Adjusts the mapper transform to align with and fit the current object. kModel 0x4 Multiplies the mapper transform by the current block transform.

Definition at line 1729 of file GiMaterial.h.

operator!=()

bool OdGiMapper::operator!= ( const OdGiMapper &  mapper ) const

inline

Definition at line 1681 of file GiMaterial.h.

operator=()

OdGiMapper & OdGiMapper::operator= ( const OdGiMapper &  mapper )

inline

Definition at line 1657 of file GiMaterial.h.

operator==()

bool OdGiMapper::operator== ( const OdGiMapper &  mapper ) const

inline

Definition at line 1671 of file GiMaterial.h.

projection()

OdGiMapper::Projection OdGiMapper::projection ( ) const

inline

Returns the type of projection for this Mapper object.

Remarks

projection() returns one of the following:

Value Description kInheritProjection 0 Inherits projection from the current material's mapper. kPlanar 1 Maps directly to XY coordinates. kBox 2 Maps to planes perpendicular to major axes. kCylinder 3 Maps to cylinders aligned with the Z-axis. kSphere 4 Maps to spheres aligned with the Z-axis.

Definition at line 1711 of file GiMaterial.h.

setAutoTransform()

void OdGiMapper::setAutoTransform ( AutoTransform  autoTransform )

inline

Sets the type of automatic transform for this Mapper object.

Parameters

autoTransform

[in] Automatic transform type.

Remarks

autoTransform must be one of the following:

Value Description kInheritAutoTransform 0x0 Inherits automatic transform from the current material's mapper. kNone 0x1 No automatic transform. kObject 0x2 Adjusts the mapper transform to align with and fit the current object. kModel 0x4 Multiplies the mapper transform by the current block transform.

Definition at line 1705 of file GiMaterial.h.

setProjection()

void OdGiMapper::setProjection ( Projection  projection )

inline

Sets the type of projection for this Mapper object.

Parameters

projection

[in] Projection type.

Remarks

projection must be one of the following:

Value Description kInheritProjection 0 Inherits projection from the current material's mapper. kPlanar 1 Maps directly to XY coordinates. kBox 2 Maps to planes perpendicular to major axes. kCylinder 3 Maps to cylinders aligned with the Z-axis. kSphere 4 Maps to spheres aligned with the Z-axis.

Definition at line 1687 of file GiMaterial.h.

setTransform()

void OdGiMapper::setTransform ( const OdGeMatrix3d &  tm )

inline

Applies the transformation matrix for this Mapper object.

Parameters

tm	[in] Transformation matrix.

Definition at line 1747 of file GiMaterial.h.

setUTiling()

void OdGiMapper::setUTiling ( Tiling  tiling )

inline

Sets the type of X-axis tiling for this Mapper object.

Parameters

tiling

[in] Tiling type.

Remarks

tiling must be one of the following:

Value Description kInheritTiling 0 Inherits tiling from the current material's mapper. kTile 1 Repeats map along image axes. kCrop 2 Crops map < 0.0 or > 1.0 on image axes. kClamp 3 Clamps (stretches) map between 0.0 and 1.0 on image axes. kMirror 4 Mirrors the material map at every integer boundary.

Definition at line 1693 of file GiMaterial.h.

setVTiling()

void OdGiMapper::setVTiling ( Tiling  tiling )

inline

Sets the type of Y-axis tiling for this Mapper object.

Parameters

tiling

[in] Tiling type.

Remarks

tiling must be one of the following:

Value Description kInheritTiling 0 Inherits tiling from the current material's mapper. kTile 1 Repeats map along image axes. kCrop 2 Crops map < 0.0 or > 1.0 on image axes. kClamp 3 Clamps (stretches) map between 0.0 and 1.0 on image axes. kMirror 4 Mirrors the material map at every integer boundary.

Definition at line 1699 of file GiMaterial.h.

transform() [1/2]

OdGeMatrix3d & OdGiMapper::transform ( )

inline

Returns a reference to the transformation matrix for this Mapper object.

Remarks

The transform matrix defines mapping of an OdGiMaterialMap image when applied to the surface of an object.

Definition at line 1741 of file GiMaterial.h.

transform() [2/2]

const OdGeMatrix3d & OdGiMapper::transform ( ) const

inline

Returns the transformation matrix for this Mapper object.

Definition at line 1735 of file GiMaterial.h.

uTiling()

OdGiMapper::Tiling OdGiMapper::uTiling ( ) const

inline

Returns the type of X-axis tiling for this Mapper object.

Remarks

tiling() returns one of the following:

Value Description kInheritTiling 0 Inherits tiling from the current material's mapper. kTile 1 Repeats map along image axes. kCrop 2 Crops map < 0.0 or > 1.0 on image axes. kClamp 3 Clamps (stretches) map between 0.0 and 1.0 on image axes. kMirror 4 Mirrors the material map at every integer boundary.

Definition at line 1717 of file GiMaterial.h.

vTiling()

OdGiMapper::Tiling OdGiMapper::vTiling ( ) const

inline

Returns the type of Y-axis tiling for this Mapper object.

Remarks

tiling() returns one of the following:

Value Description kInheritTiling 0 Inherits tiling from the current material's mapper. kTile 1 Repeats map along image axes. kCrop 2 Crops map < 0.0 or > 1.0 on image axes. kClamp 3 Clamps (stretches) map between 0.0 and 1.0 on image axes. kMirror 4 Mirrors the material map at every integer boundary.

Definition at line 1723 of file GiMaterial.h.

Member Data Documentation

kIdentity

ODGI_EXPORT_STATIC const OdGiMapper OdGiMapper::kIdentity

static

Definition at line 1167 of file GiMaterial.h.

---

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

• GiMaterial.h