#include <AveMaterial.h>

Inheritance diagram for OdAveWoodMaterial:

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdAveWoodMaterial)

virtual OdAve::MaterialType	type ()

OdUInt32	lightColor ()

OdUInt32	darkColor ()

void	setLightColor (OdUInt32 lightColor)

void	setDarkColor (OdUInt32 darkColor)

double	lightDark ()

void	setLightDark (double lightDark)

double	ringDensity ()

void	setRingDensity (double ringDensity)

double	ringWidth ()

void	setRingWidth (double ringWidth)

double	ringShape ()

void	setRingShape (double ringShape)

double	scale ()

void	setScale (double scale)

Public Member Functions inherited from OdAveMaterial
	ODRX_DECLARE_MEMBERS (OdAveMaterial)

OdResult	writeMaterial (OdDbDatabase *pDb=NULL, const OdDbHandle &holderHandle=0)

bool	attachToObject (OdDbObjectId entityId)

bool	attachToLayer (OdDbObjectId layerId)

bool	attachToACI (OdUInt16 colorIndex)

bool	isAttribUsed (OdAve::MaterialAttrib attributes)

OdString	name () const

OdString	description () const

void	setName (const OdString &name)

void	setDescription (const OdString &description)

double	ambientFactor () const

OdUInt32	ambientColor () const

bool	ambientColorCurrent () const

bool	ambientLock () const

void	setAmbientFactor (double ambientFactor)

void	setAmbientColor (OdUInt32 ambientColor)

void	setAmbientColorCurrent (bool currentColor)

void	setAmbientLock (bool ambientLock)

double	diffuseFactor () const

OdUInt32	diffuseColor () const

bool	diffuseColorCurrent () const

OdAveBitmap &	diffuseBitmap () const

void	setDiffuseFactor (double diffuseFactor)

void	setDiffuseColor (OdUInt32 diffuseColor)

void	setDiffuseColorCurrent (bool currentColor)

double	specularFactor () const

OdUInt32	specularColor () const

bool	specularColorCurrent () const

bool	specularMirror () const

bool	specularLock () const

OdAveBitmap &	specularBitmap ()

const OdAveBitmap &	specularBitmap () const

void	setSpecularFactor (double specularFactor)

void	setSpecularColor (OdUInt32 specularColor)

void	setSpecularColorCurrent (bool colorCurrrent)

void	setSpecularMirror (bool mirror)

void	setSpecularLock (bool specularLock)

double	roughness () const

void	setRoughness (double)

double	transparency () const

OdAveBitmap &	transparencyBitmap () const

void	setTransparency (double transparency)

double	refraction () const

void	setRefraction (double refraction) const

OdAveBitmap &	bumpMap ()

const OdAveBitmap &	bumpMap () const

OdDbObjectId	holderId () const

OdString	handleDbMaterial () const

void	setHandleDbMaterial (const OdString &sDesc)

	~OdAveMaterial ()

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

Protected Member Functions
	OdAveWoodMaterial ()

	OdAveWoodMaterial (OdAveMaterialImpl *pImpl)

Protected Member Functions inherited from OdAveMaterial
	OdAveMaterial ()

	OdAveMaterial (OdAveMaterialImpl *pImpl)

Additional Inherited Members
Static Public Member Functions inherited from OdAveMaterial
static OdAveMaterialPtr	getMaterial (const OdDbObjectId &blockRefId)

static OdString	getMaterialName (const OdDbObjectId &blockRefId)

static void	detachFromObject (OdDbObjectId entityId)

static void	detachFromLayer (OdDbObjectId layerId)

static void	detachFromACI (OdDbDatabase *pDb, OdUInt16 colorIndex)

static bool	getAttachedMaterial (const OdDbObjectId &sourceId, OdDbObjectId &blockRefId)

static bool	getAttachedMaterial (OdDbDatabase *pDb, OdUInt16 colorIndex, OdDbObjectId &blockRefId)

static void	getAciMaterialMap (OdDbDatabase *pDb, OdDbObjectIdArray &blockRefIds)

Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

Protected Attributes inherited from OdAveMaterial
OdAveMaterialImpl *	m_pImpl

Detailed Description

This class represents Wood Material properties for shaded entities.

Remarks: Wood materials consist of a bicolor woodgrain pattern.

Definition at line 836 of file AveMaterial.h.

Constructor & Destructor Documentation

◆ OdAveWoodMaterial() [1/2]

OdAveWoodMaterial::OdAveWoodMaterial ( )

protected

◆ OdAveWoodMaterial() [2/2]

OdAveWoodMaterial::OdAveWoodMaterial ( OdAveMaterialImpl * pImpl )

protected

Member Function Documentation

◆ darkColor()

OdUInt32 OdAveWoodMaterial::darkColor ( )

Returns the dark color of this Wood Material object.

Remarks: darkColor() returns a 24-bit RGB color.

◆ lightColor()

OdUInt32 OdAveWoodMaterial::lightColor ( )

Returns the light color of this Material object.

Remarks: lightColor() returns a 24-bit RGB color.

◆ lightDark()

double OdAveWoodMaterial::lightDark ( )

Returns the mixture of light vs. dark rings in this Wood Material object.

Returns: Returns a value in the range [0.0 .. 1.0].

Renders 0.0 Mostly dark. 1.0 Mostly light.

◆ ODRX_DECLARE_MEMBERS()

OdAveWoodMaterial::ODRX_DECLARE_MEMBERS ( OdAveWoodMaterial )

◆ ringDensity()

double OdAveWoodMaterial::ringDensity ( )

Returns the ring density of this Wood Material object.

Remarks: The ring density is with respect to the objects to which this Wood Material object are attached. Smaller values result in a coarser texture with less rings.

◆ ringShape()

double OdAveWoodMaterial::ringShape ( )

Returns the ring shape parameters for this Wood Material object.

Returns: Returns a value in the range [0.0 .. 1.0].

Renders 0.0 Circular rings. 1.0 Most irregular rings.

◆ ringWidth()

double OdAveWoodMaterial::ringWidth ( )

Returns the ring width variation for this Wood Material object.

Returns: Returns a value in the range [0.0 .. 1.0].

Renders 0.0 Rings are uniform. 1.0 Rings have greatest variation.

◆ scale()

double OdAveWoodMaterial::scale ( )

Returns the scale of this Wood Material object.

Remarks: The scale is with respect to the objects to which this Wood Material object are attached. Smaller values result in a finer texture with more rings.

◆ setDarkColor()

void OdAveWoodMaterial::setDarkColor ( OdUInt32 darkColor )

Sets the dark color of this Wood Material object.

Parameters

darkColor [in] 24-bit RGB color.

◆ setLightColor()

void OdAveWoodMaterial::setLightColor ( OdUInt32 lightColor )

Sets the light color of this Wood Material object.

Parameters

lightColor [in] 24-bit RGB color.

◆ setLightDark()

void OdAveWoodMaterial::setLightDark ( double lightDark )

Sets the mixture of light vs. dark rings in this Wood Material object.

Parameters

lightDark [in] Light/Dark mixture. [0.0 .. 1.0]

Renders 0.0 Mostly dark. 1.0 Mostly light.

◆ setRingDensity()

void OdAveWoodMaterial::setRingDensity ( double ringDensity )

Sets the ring density of this Wood Material object.

Parameters

ringDensity [in] Ring Density.

Remarks: The ring density is with respect to the objects to which this Wood Material object are attached. Smaller values result in a coarser texture with less rings.

◆ setRingShape()

void OdAveWoodMaterial::setRingShape ( double ringShape )

Sets the ring shape parameters for this Wood Material object.

Parameters

ringShape [in] Ring shape parameter. [0.0 .. 1.0]

Remarks

Renders 0.0 Circular rings. 1.0 Most irregular rings.F

◆ setRingWidth()

void OdAveWoodMaterial::setRingWidth ( double ringWidth )

Sets the ring width parameter for this Wood Material object.

Parameters

ringWidth [in] Ring width parameter. [0.0 .. 1.0]

Remarks

Renders 0.0 Rings are uniform. 1.0 Rings have greatest variation.

◆ setScale()

void OdAveWoodMaterial::setScale ( double scale )

Sets the scale of this Wood Material object.

Parameters

scale [in] Scale.

Remarks: The scale is with respect to the objects to which this Wood Material object are attached. Smaller values result in a finer texture with rings.

◆ type()

virtual OdAve::MaterialType OdAveWoodMaterial::type ( )

virtual

Returns the type of this Material object.

Remarks: type() returns one of the following:

Value kStandard 0 kGranite 1 kMarble 2 kWood 3

Reimplemented from OdAveMaterial.

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

AveMaterial.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OdAveWoodMaterial() [1/2]

◆ OdAveWoodMaterial() [2/2]

Member Function Documentation

◆ darkColor()

◆ lightColor()

◆ lightDark()

◆ ODRX_DECLARE_MEMBERS()

◆ ringDensity()

◆ ringShape()

◆ ringWidth()

◆ scale()

◆ setDarkColor()

◆ setLightColor()

◆ setLightDark()

◆ setRingDensity()

◆ setRingShape()

◆ setRingWidth()

◆ setScale()

◆ type()