CFx SDK Documentation  2020SP3
Public Types | Public Member Functions | Protected Member Functions | List of all members
OdAveGraniteMaterial Class Reference

#include <AveMaterial.h>

Inheritance diagram for OdAveGraniteMaterial:
OdAveMaterial OdRxObject

Public Types

enum  GraniteColor { kFirst = 0, kSecond = 1, kThird = 2, kFourth = 3 }
 

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdAveGraniteMaterial)
 
virtual OdAve::MaterialType type ()
 
double colorFactor (GraniteColor graniteColor)
 
OdUInt32 color (GraniteColor graniteColor)
 
void setColorFactor (GraniteColor graniteColor, double colorFactor)
 
void setColor (GraniteColor graniteColor, OdUInt32 color)
 
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

 OdAveGraniteMaterial ()
 
 OdAveGraniteMaterial (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 Granite Material properties for shaded entities.

Remarks
AVE Granite Materials consist of a random distribution of four colors. Corresponding C++ library: TD_Ave

<group OdAve_Classes>

Definition at line 543 of file AveMaterial.h.

Member Enumeration Documentation

◆ GraniteColor

Defines the color index for each of the four colors that are present in a Granite Material object.

Enumerator
kFirst 
kSecond 
kThird 
kFourth 

Definition at line 552 of file AveMaterial.h.

Constructor & Destructor Documentation

◆ OdAveGraniteMaterial() [1/2]

OdAveGraniteMaterial::OdAveGraniteMaterial ( )
protected

◆ OdAveGraniteMaterial() [2/2]

OdAveGraniteMaterial::OdAveGraniteMaterial ( OdAveMaterialImpl pImpl)
protected

Member Function Documentation

◆ color()

OdUInt32 OdAveGraniteMaterial::color ( GraniteColor  graniteColor)

Returns the color for the specified granite color of this Granite Material object.

Parameters
graniteColor[in] Granite color.
Remarks
color() returns a 24-bit RGB color.

graniteColor must be one of the following:

Value kFirst 0 kSecond 1 kThird 2 kFourth 3

◆ colorFactor()

double OdAveGraniteMaterial::colorFactor ( GraniteColor  graniteColor)

Returns the color factor for the specified granite color of this Granite Material object.

Parameters
graniteColor[in] Granite color.
Returns
Returns a value in the range [0.0 .. 1.0].
Remarks
There are four colors associated with a Granite Material object. The color factors determine the relative amounts of the four granite colors.

graniteColor must be one of the following:

Value kFirst 0 kSecond 1 kThird 2 kFourth 3

◆ ODRX_DECLARE_MEMBERS()

OdAveGraniteMaterial::ODRX_DECLARE_MEMBERS ( OdAveGraniteMaterial  )

◆ scale()

double OdAveGraniteMaterial::scale ( )

Returns the scale of this Granite Material object.

Remarks
The scale is with respect to the objects to which this Granite Material object are attached. Larger values result in a coarser texture with more graininess.

◆ setColor()

void OdAveGraniteMaterial::setColor ( GraniteColor  graniteColor,
OdUInt32  color 
)

Sets the color for the specified granite color for this Granite Material object.

Parameters
graniteColor[in] Granite color.
color[in] 24-bit RGB color.
Remarks
graniteColor must be one of the following:

Value kFirst 0 kSecond 1 kThird 2 kFourth 3

There are four colors associated with a Granite Material object. To use less than four materials, make two or more of them the same, or set one or more of them to 0.

◆ setColorFactor()

void OdAveGraniteMaterial::setColorFactor ( GraniteColor  graniteColor,
double  colorFactor 
)

Sets the color factor for the specified granite color of this Granite Material object.

Parameters
graniteColor[in] Granite color.
colorFactor[in] Color factor. [0.0 .. 1.0]
Remarks
There are four colors associated with a Granite Material object. The color factors determine the relative amounts of the four granite colors.

graniteColor must be one of the following:

Value kFirst 0 kSecond 1 kThird 2 kFourth 3

There are four colors associated with a Granite Material object. To use less than four materials, make two or more of them the same, or set one or more of them to 0.

◆ setScale()

void OdAveGraniteMaterial::setScale ( double  scale)

Sets the scale of this Granite Material object.

Parameters
scale[in] Scale.
Remarks
The scale is with respect to the objects to which this Granite Material object are attached. Larger values result in a coarser texture with more graininess.

◆ setSharpness()

void OdAveGraniteMaterial::setSharpness ( double  sharpness)

Sets the sharpness of this Granite Material object.

Parameters
sharpness[in] Sharpness. [0.0 .. 1.0]
Remarks
Renders 0.0 Colors are melded. 1.0 Colors are discrete.

◆ sharpness()

double OdAveGraniteMaterial::sharpness ( )

Returns the sharpness of this Material object.

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

Renders 0.0 Colors are melded. 1.0 Colors are discrete.

◆ type()

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