CFx SDK Documentation  2020SP3
Public Member Functions | List of all members
OdGiProceduralGenerator Class Referenceabstract

#include <GiProceduralGenerator.h>

Inheritance diagram for OdGiProceduralGenerator:
OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdGiProceduralGenerator)
 
virtual bool generateProceduralTexture (OdGiProceduralTexturePtr pTexture, OdGiImageBGRA32 &image, double renderCoef=1.0)=0
 
virtual void generateProceduralWood (OdGiPixelBGRA32 color1, OdGiPixelBGRA32 color2, double radialNoise, double axialNoise, double grainThickness, OdGiImageBGRA32 &image, double renderCoef=1.0)=0
 
virtual void generateProceduralMarble (OdGiPixelBGRA32 stoneColor, OdGiPixelBGRA32 veinColor, double veinSpacing, double veinWidth, OdGiImageBGRA32 &image, double renderCoef=1.0)=0
 
virtual void setColorGradient (const OdGiGradientGenerator &gradient)=0
 
virtual const OdGiGradientGeneratorcolorGradient () const =0
 
- 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
 

Additional Inherited Members

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

Detailed Description

Procedural textures generator.

See also
TD_Gi

<group OdGi_Classes>

Definition at line 344 of file GiProceduralGenerator.h.

Member Function Documentation

◆ colorGradient()

virtual const OdGiGradientGenerator& OdGiProceduralGenerator::colorGradient ( ) const
pure virtual

Get color gradient.

◆ generateProceduralMarble()

virtual void OdGiProceduralGenerator::generateProceduralMarble ( OdGiPixelBGRA32  stoneColor,
OdGiPixelBGRA32  veinColor,
double  veinSpacing,
double  veinWidth,
OdGiImageBGRA32 image,
double  renderCoef = 1.0 
)
pure virtual

Generate procedural marble texture.

Parameters
veinColor[in] Color of marble veins.
veinSpacing[in] Distance between veins multiplier.
veinWidth[in] Marble veins width multiplier.
image[out] Output image.
renderCoef[in] Texture detail multiplier. 1.0 - most standard device value, 10.0 - normal rendering. This value can be calculated from raster resolution.

◆ generateProceduralTexture()

virtual bool OdGiProceduralGenerator::generateProceduralTexture ( OdGiProceduralTexturePtr  pTexture,
OdGiImageBGRA32 image,
double  renderCoef = 1.0 
)
pure virtual

Generate procedural texture. Returns false if protocol extension not initialized or no support for current procedural texture type.

Parameters
pTexture[in] Procedural texture pointer.
image[out] Output image.
renderCoef[in] Texture detail multiplier. 1.0 - most standard device value, 10.0 - normal rendering. This value can be calculated from raster resolution.

◆ generateProceduralWood()

virtual void OdGiProceduralGenerator::generateProceduralWood ( OdGiPixelBGRA32  color1,
OdGiPixelBGRA32  color2,
double  radialNoise,
double  axialNoise,
double  grainThickness,
OdGiImageBGRA32 image,
double  renderCoef = 1.0 
)
pure virtual

Generate procedural wood texture.

Parameters
color1[in] First wood texture color.
color2[in] Second wood texture color.
radialNoise[in] Radial noise amount.
axialNoise[in] Axial noise amount.
grainThickness[in] Thickness of wood grains.
image[out] Output image.
renderCoef[in] Texture detail multiplier. 1.0 - most standard device value, 10.0 - normal rendering. This value can be calculated from raster resolution.

◆ ODRX_DECLARE_MEMBERS()

OdGiProceduralGenerator::ODRX_DECLARE_MEMBERS ( OdGiProceduralGenerator  )

◆ setColorGradient()

virtual void OdGiProceduralGenerator::setColorGradient ( const OdGiGradientGenerator gradient)
pure virtual

Set color gradient.

\remarks
If gradient is not set up, it will be generated in generateProceduralXXX

functions. This function may be called before a generateProceduralXXX call for changing palettes in procedural texture generation.


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