OdGiMarbleTexture Class Reference

#include <GiMaterial.h>

Inheritance diagram for OdGiMarbleTexture:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGiMarbleTexture)
	OdGiMarbleTexture ()
virtual Type	type () const
virtual void	setStoneColor (const OdGiMaterialColor &stoneColor)
virtual const OdGiMaterialColor &	stoneColor (void) const
virtual void	setVeinColor (const OdGiMaterialColor &veinColor)
virtual const OdGiMaterialColor &	veinColor (void) const
virtual void	setVeinSpacing (double veinSpacing)
virtual double	veinSpacing (void) const
virtual void	setVeinWidth (double veinWidth)
virtual double	veinWidth (void) const
virtual bool	operator== (const OdGiMaterialTexture &texture) const
OdGiMarbleTexture &	operator= (const OdGiMarbleTexture &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 marble procedural material textures. Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 1296 of file GiMaterial.h.

Constructor & Destructor Documentation

OdGiMarbleTexture()

OdGiMarbleTexture::OdGiMarbleTexture ( )

inline

Default constructor for the OdGiMarbleTexture class. Sets the vein spacing and width to 0.

Definition at line 2508 of file GiMaterial.h.

Member Function Documentation

copyFrom()

void OdGiMarbleTexture::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 2584 of file GiMaterial.h.

ODRX_DECLARE_MEMBERS()

OdGiMarbleTexture::ODRX_DECLARE_MEMBERS

(

OdGiMarbleTexture

)

operator=()

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

inline

Assignment operator for the OdGiMarbleTexture class. Assigns stone and vein colors, vein spacing, vein width and returns a reference to the marble texture.

Parameters

texture

[in] Texture to be assigned.

Returns

a reference to this marble texture.

Definition at line 2575 of file GiMaterial.h.

operator==()

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

inlinevirtual

Equality operator for the OdGiMarbleTexture class. Textures are equal if: the specified texture is marble texture stone colors are equal vein colors are equal vein spacing values are equal vein width values are equal

Parameters

texture

[in] Texture to be compared.

Returns

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

Reimplemented from OdGiMaterialTexture.

Definition at line 2563 of file GiMaterial.h.

setStoneColor()

void OdGiMarbleTexture::setStoneColor ( const OdGiMaterialColor &  stoneColor )

inlinevirtual

Sets the stone color of the marble.

Parameters

stoneColor

[in] Color value.

Definition at line 2515 of file GiMaterial.h.

setVeinColor()

void OdGiMarbleTexture::setVeinColor ( const OdGiMaterialColor &  veinColor )

inlinevirtual

Sets the vein color of the marble.

Parameters

veinColor

[in] Color value.

Definition at line 2527 of file GiMaterial.h.

setVeinSpacing()

void OdGiMarbleTexture::setVeinSpacing ( double  veinSpacing )

inlinevirtual

Sets the spacing between veins of the marble.

Parameters

veinSpacing

[in] Spacing value.

Definition at line 2539 of file GiMaterial.h.

setVeinWidth()

void OdGiMarbleTexture::setVeinWidth ( double  veinWidth )

inlinevirtual

Sets the vein width of the marble.

Parameters

veinWidth

[in] Vein width value.

Definition at line 2551 of file GiMaterial.h.

stoneColor()

const OdGiMaterialColor & OdGiMarbleTexture::stoneColor ( void  ) const

inlinevirtual

Retrieves the stone color of the marble.

Returns

reference to the OdGiMaterialColor object that represents stone color of the marble.

Definition at line 2521 of file GiMaterial.h.

type()

virtual Type OdGiMarbleTexture::type ( ) const

inlinevirtual

Retrieves the type of the procedural texture.

Returns

the kMarble value from the Type enumeration.

Implements OdGiProceduralTexture.

Definition at line 1311 of file GiMaterial.h.

veinColor()

const OdGiMaterialColor & OdGiMarbleTexture::veinColor ( void  ) const

inlinevirtual

Retrieves the vein color of the marble.

Returns

reference to the OdGiMaterialColor object that represents vein color of the marble.

Definition at line 2533 of file GiMaterial.h.

veinSpacing()

double OdGiMarbleTexture::veinSpacing ( void  ) const

inlinevirtual

Retrieves vein spacing of this marble texture.

Returns

the spacing between veins of the marble.

Definition at line 2545 of file GiMaterial.h.

veinWidth()

double OdGiMarbleTexture::veinWidth ( void  ) const

inlinevirtual

Retrieves vein width of this marble texture.

Returns

the vein width of the marble.

Definition at line 2557 of file GiMaterial.h.

---

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

• GiMaterial.h