CFx SDK Documentation  2022 SP0
Public Member Functions | Protected Member Functions | List of all members
OdAveMarbleMaterial Class Reference

#include <AveMaterial.h>

Inheritance diagram for OdAveMarbleMaterial:
OdAveMaterial OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdAveMarbleMaterial)
 
virtual OdAve::MaterialType type ()
 
OdUInt32 stoneColor ()
 
OdUInt32 veinColor ()
 
void stoneColor (OdUInt32 color)
 
void veinColor (OdUInt32 color)
 
OdUInt32 turbulence ()
 
void setTurbulence (OdUInt32 turbulence)
 
double sharpness ()
 
void setSharpness (double sharpness)
 
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
 
OdAveBitmapdiffuseBitmap () 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
 
OdAveBitmapspecularBitmap ()
 
const OdAveBitmapspecularBitmap () 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
 
OdAveBitmaptransparencyBitmap () const
 
void setTransparency (double transparency)
 
double refraction () const
 
void setRefraction (double refraction) const
 
OdAveBitmapbumpMap ()
 
const OdAveBitmapbumpMap () 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 OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () 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

 OdAveMarbleMaterial ()
 
 OdAveMarbleMaterial (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 OdRxClassdesc ()
 
- Protected Attributes inherited from OdAveMaterial
OdAveMaterialImplm_pImpl
 

Detailed Description

This class represents AVE Marble Material properties for shaded entities.

Remarks
AVE Marble Materials consist of a stone color and a vein color. Corresponding C++ library: TD_Ave

<group OdAve_Classes>

Definition at line 719 of file AveMaterial.h.

Constructor & Destructor Documentation

◆ OdAveMarbleMaterial() [1/2]

OdAveMarbleMaterial::OdAveMarbleMaterial ( )
protected

◆ OdAveMarbleMaterial() [2/2]

OdAveMarbleMaterial::OdAveMarbleMaterial ( OdAveMaterialImpl pImpl)
protected

Member Function Documentation

◆ ODRX_DECLARE_MEMBERS()

OdAveMarbleMaterial::ODRX_DECLARE_MEMBERS ( OdAveMarbleMaterial  )

◆ scale()

double OdAveMarbleMaterial::scale ( )

Returns the scale of this Marble Material object.

Remarks
The scale is with respect to the objects to which this Marble Material object are attached. Smaller values result in less veins.

◆ setScale()

void OdAveMarbleMaterial::setScale ( double  scale)

Sets the scale of this Marble Material object.

Parameters
scale[in] Scale.
Remarks
The scale is with respect to the objects to which this Marble Material object are attached. Smaller values result in less veins.

◆ setSharpness()

void OdAveMarbleMaterial::setSharpness ( double  sharpness)

Sets the sharpness of this Marble Material object.

Parameters
sharpness[in] Sharpness. [0.0 .. 1.0]

Renders 0.0 Colors are melded. 1.0 Colors are discrete.

◆ setTurbulence()

void OdAveMarbleMaterial::setTurbulence ( OdUInt32  turbulence)

Sets the vein turbulance of this Marble Material object.

Parameters
turbulence[in] Turbulence.
Remarks
Higher values result in more swirling of the veins, and take longer to render. Values in the range [1..10] are recommended.

◆ sharpness()

double OdAveMarbleMaterial::sharpness ( )

Returns the sharpness of this Marble Material object.

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

Renders 0.0 Colors are melded. 1.0 Colors are discrete.

◆ stoneColor() [1/2]

OdUInt32 OdAveMarbleMaterial::stoneColor ( )

Accesses the stone color for this Marble Material object.

Remarks
stoneColor() returns a 24-bit RGB color.

◆ stoneColor() [2/2]

void OdAveMarbleMaterial::stoneColor ( OdUInt32  color)

Accesses the stone color for this Marble Material object.

Parameters
color[in] 24-bit RGB color.

◆ turbulence()

OdUInt32 OdAveMarbleMaterial::turbulence ( )

Returns the vein turbulance of this Marble Material object.

Remarks
Higher values result in more swirling of the veins, and take longer to render. Values in the range [1..10] are recommended.

◆ type()

virtual OdAve::MaterialType OdAveMarbleMaterial::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.

◆ veinColor() [1/2]

OdUInt32 OdAveMarbleMaterial::veinColor ( )

Accesses the vein color for this Marble Material object.

Returns
Returns a 24-bit RGB color.

◆ veinColor() [2/2]

void OdAveMarbleMaterial::veinColor ( OdUInt32  color)

Accesses the vein color for this Marble Material object.

Parameters
color[in] 24-bit RGB color.

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