OdGiWoodTexture Class Reference

#include <GiMaterial.h>

Inheritance diagram for OdGiWoodTexture:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGiWoodTexture)
	OdGiWoodTexture ()
virtual Type	type () const
virtual void	setColor1 (const OdGiMaterialColor &woodColor1)
virtual const OdGiMaterialColor &	color1 (void) const
virtual void	setColor2 (const OdGiMaterialColor &woodColor2)
virtual const OdGiMaterialColor &	color2 (void) const
virtual void	setRadialNoise (double radialNoise)
virtual double	radialNoise (void) const
virtual void	setAxialNoise (double axialNoise)
virtual double	axialNoise (void) const
virtual void	setGrainThickness (double grainThickness)
virtual double	grainThickness (void) const
virtual bool	operator== (const OdGiMaterialTexture &texture) const
OdGiWoodTexture &	operator= (const OdGiWoodTexture &texture)
void	copyFrom (const OdRxObject *pSource)
Public Member Functions inherited from OdGiProceduralTexture
	ODRX_DECLARE_MEMBERS (OdGiProceduralTexture)
virtual Type	type () const =0
Public Member Functions inherited from OdGiMaterialTexture
	ODRX_DECLARE_MEMBERS (OdGiMaterialTexture)
virtual bool	operator== (const OdGiMaterialTexture &texture) const
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () const
virtual void	addRef ()=0
virtual void	release ()=0
virtual long	numRefs () const
bool	isKindOf (const OdRxClass *pClass) const
virtual OdRxObjectPtr	clone () const
virtual void	copyFrom (const OdRxObject *pSource)
virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Additional Inherited Members
Public Types inherited from OdGiProceduralTexture
enum	Type { kWood = 0 , kMarble = 1 , kGeneric = 2 }
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()
Protected Member Functions inherited from OdGiProceduralTexture
	OdGiProceduralTexture ()
	~OdGiProceduralTexture ()
Protected Member Functions inherited from OdGiMaterialTexture
	OdGiMaterialTexture ()
	~OdGiMaterialTexture ()

Detailed Description

This class defines wood procedural material textures. Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 1152 of file GiMaterial.h.

Constructor & Destructor Documentation

OdGiWoodTexture()

OdGiWoodTexture::OdGiWoodTexture ( )

inline

Default constructor for the OdGiWoodTexture class. Sets the radial noise, axial noise and grain thickness to 0.

Definition at line 2397 of file GiMaterial.h.

Member Function Documentation

axialNoise()

double OdGiWoodTexture::axialNoise ( void  ) const

inlinevirtual

Retrieves the axial noise level of the wood grain.

Returns

axial noise level as value of the double type.

Definition at line 2447 of file GiMaterial.h.

color1()

const OdGiMaterialColor & OdGiWoodTexture::color1 ( void  ) const

inlinevirtual

Retrieves the color of the first wood grain.

Returns

reference to the color of the first wood grain represented by OdGiMaterialColor class.

Definition at line 2411 of file GiMaterial.h.

color2()

const OdGiMaterialColor & OdGiWoodTexture::color2 ( void  ) const

inlinevirtual

Retrieves the color of the second wood grain.

Returns

reference to the color of the second wood grain represented by OdGiMaterialColor class.

Definition at line 2423 of file GiMaterial.h.

copyFrom()

void OdGiWoodTexture::copyFrom ( const OdRxObject *  pSource )

inlinevirtual

Copies the data of the source object to the current object.

Parameters

pSource

[in] Input source object.

Reimplemented from OdRxObject.

Definition at line 2488 of file GiMaterial.h.

grainThickness()

double OdGiWoodTexture::grainThickness ( void  ) const

inlinevirtual

Retrieves the thickness of the wood grain.

Returns

the thickness of the wood grain as value of the double type.

Definition at line 2459 of file GiMaterial.h.

ODRX_DECLARE_MEMBERS()

OdGiWoodTexture::ODRX_DECLARE_MEMBERS

(

OdGiWoodTexture

)

operator=()

OdGiWoodTexture & OdGiWoodTexture::operator= ( const OdGiWoodTexture &  texture )

inline

Assignment operator for the OdGiWoodTexture class. Assigns first and second grain colors, radial and axial noise levels, grain thickness value and returns a reference to the wood texture.

Parameters

texture

[in] Texture to be assigned.

Returns

a reference to this wood texture.

Definition at line 2478 of file GiMaterial.h.

operator==()

bool OdGiWoodTexture::operator== ( const OdGiMaterialTexture &  texture ) const

inlinevirtual

Equality operator for the OdGiWoodTexture class. Textures are equal if: the specified texture is wooden texture first grain colors are equal second grain colors are equal radial noise levels are equal axial noise levels are equal wood grain thickness values are equal

Parameters

texture

[in] Texture to be compared.

Returns

true if the specified texture is equal to this wood texture, false otherwise.

Reimplemented from OdGiMaterialTexture.

Definition at line 2465 of file GiMaterial.h.

radialNoise()

double OdGiWoodTexture::radialNoise ( void  ) const

inlinevirtual

Retrieves the radial noise level of the wood grain.

Returns

radial noise level as value of the double type.

Definition at line 2435 of file GiMaterial.h.

setAxialNoise()

void OdGiWoodTexture::setAxialNoise ( double  axialNoise )

inlinevirtual

Sets the axial noise level of the wood grain.

Parameters

axialNoise

[in] Axial noise level.

Definition at line 2441 of file GiMaterial.h.

setColor1()

void OdGiWoodTexture::setColor1 ( const OdGiMaterialColor &  woodColor1 )

inlinevirtual

Sets the color of the first wood grain.

Parameters

woodColor1

[in] Color value.

Definition at line 2405 of file GiMaterial.h.

setColor2()

void OdGiWoodTexture::setColor2 ( const OdGiMaterialColor &  woodColor2 )

inlinevirtual

Sets the color of the second wood grain.

Parameters

woodColor2

[in] Color value.

Definition at line 2417 of file GiMaterial.h.

setGrainThickness()

void OdGiWoodTexture::setGrainThickness ( double  grainThickness )

inlinevirtual

Sets the thickness of the wood grain.

Parameters

grainThickness

[in] Thickness value.

Definition at line 2453 of file GiMaterial.h.

setRadialNoise()

void OdGiWoodTexture::setRadialNoise ( double  radialNoise )

inlinevirtual

Sets the radial noise level of the wood grain.

Parameters

radialNoise

[in] Radial noise level.

Definition at line 2429 of file GiMaterial.h.

type()

virtual Type OdGiWoodTexture::type ( ) const

inlinevirtual

Retrieves the type of the procedural texture.

Returns

the kWood value from the Type enumeration.

Implements OdGiProceduralTexture.

Definition at line 1167 of file GiMaterial.h.

---

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

• GiMaterial.h