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

#include <AveDefs.h>

Public Member Functions

virtual ~OdAveBitmap ()
 
virtual double blendFactor ()=0
 
virtual void source (OdString &filename)=0
 
virtual double scaleU ()=0
 
virtual double scaleV ()=0
 
virtual double offsetU ()=0
 
virtual double offsetV ()=0
 
virtual OdAve::TileMethod tileMethod ()=0
 
virtual bool useAutoAxis ()=0
 
virtual bool fitToObject ()=0
 
virtual void setBlendFactor (double blendFactor)=0
 
virtual void setSource (const OdString &filename)=0
 
virtual void setScaleU (double scaleU)=0
 
virtual void setScaleV (double scaleV)=0
 
virtual void setOffsetU (double offsetU)=0
 
virtual void setOffsetV (double offsetV)=0
 
virtual void setTileMethod (OdAve::TileMethod tileMethod)=0
 
virtual void setUseAutoAxis (bool useAutoAxis)=0
 
virtual void setFitToObject (bool fitToObject)=0
 

Detailed Description

This class is the base class for AVE Bitmap objects.

Corresponding C++ library: TD_Ave <group OdAve_Classes>

Definition at line 147 of file AveDefs.h.

Constructor & Destructor Documentation

◆ ~OdAveBitmap()

virtual OdAveBitmap::~OdAveBitmap ( )
inlinevirtual

Definition at line 150 of file AveDefs.h.

Member Function Documentation

◆ blendFactor()

virtual double OdAveBitmap::blendFactor ( )
pure virtual

Returns the blend factor for this Bitmap object.

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

A blend factor of 0.0 makes the Bitmap invisible. A blend factor of 1.0 makes it opaque. In between, the Bitmap is transparent.

◆ fitToObject()

virtual bool OdAveBitmap::fitToObject ( )
pure virtual

Returns true if and only if this Bitmap object is automatically scaled to the object to which this bitmap is attached.

◆ offsetU()

virtual double OdAveBitmap::offsetU ( )
pure virtual

Returns the offset of this Bitmap object in the U-direction.

Remarks
Returns a value in the range [-1.0 .. 1.0].

◆ offsetV()

virtual double OdAveBitmap::offsetV ( )
pure virtual

Returns the offset of this Bitmap object in the V-direction.

Remarks
Returns a value in the range [-1.0 .. 1.0].

◆ scaleU()

virtual double OdAveBitmap::scaleU ( )
pure virtual

Returns the scale of this Bitmap object in the U-direction.

Remarks
This is the number of repetitions of this Bitmap object in the specified direction.

◆ scaleV()

virtual double OdAveBitmap::scaleV ( )
pure virtual

Returns the scale of this Bitmap object in the V-direction.

Remarks
This is the number of repetitions of this Bitmap object in the specified direction.

◆ setBlendFactor()

virtual void OdAveBitmap::setBlendFactor ( double  blendFactor)
pure virtual

Sets the blend factor for this Bitmap object.

Parameters
blendFactor[in] Blend factor. [0.0 .. 1.0]
Remarks
A blend factor of 0.0 makes the Bitmap invisible. A blend factor of 1.0 makes it opaque. In between, the Bitmap is transparent.

◆ setFitToObject()

virtual void OdAveBitmap::setFitToObject ( bool  fitToObject)
pure virtual

Controls the automatically scaling of this Bitmap object to the object to which it is attached.

Parameters
fitToObject[in] Controls automatic scaling.

◆ setOffsetU()

virtual void OdAveBitmap::setOffsetU ( double  offsetU)
pure virtual

Sets the offset of this Bitmap object in the U-direction.

Parameters
offsetU[in] Offset in U-direction. [-1.0 .. 1.0].

◆ setOffsetV()

virtual void OdAveBitmap::setOffsetV ( double  offsetV)
pure virtual

Sets the offset of this Bitmap object in the V-direction.

Parameters
offsetV[in] Offset in V-direction. [-1.0 .. 1.0].

◆ setScaleU()

virtual void OdAveBitmap::setScaleU ( double  scaleU)
pure virtual

Sets the scale of this Bitmap object in the U-direction.

Parameters
scaleU[in] Scale in U-direction.
Remarks
This is the number of repetitions of this Bitmap object in the specified direction.

◆ setScaleV()

virtual void OdAveBitmap::setScaleV ( double  scaleV)
pure virtual

Sets the scale of this Bitmap object in the V-direction.

Parameters
scaleV[in] Scale in V-direction.
Remarks
This is the number of repetitions of this Bitmap object in the specified direction.

◆ setSource()

virtual void OdAveBitmap::setSource ( const OdString &  filename)
pure virtual

Returns the source filename of this Bitmap object.

Remarks
Parameters
filename[in] Filename.

◆ setTileMethod()

virtual void OdAveBitmap::setTileMethod ( OdAve::TileMethod  tileMethod)
pure virtual

Sets the tile method of this Bitmap object.

Parameters
tileMethod[in] Tile method.
Remarks
tileMethod must be one of the following:

Value Description kTmDefault 0 Tiling as set for the material. kTmTile 1 Tiled. kTmCrop 2 Cropped. kTmClamp 3 Clamped.

◆ setUseAutoAxis()

virtual void OdAveBitmap::setUseAutoAxis ( bool  useAutoAxis)
pure virtual

Controls the use of Auto Axis by this Bitmap object.

Parameters
useAutoAxis[in] Controls use of Auto Axis.
Remarks
AutoAxis automatically maps materials to surfaces whose normals are the X, Y, and Z axes.

If AutoAxis is not used, only surfaces whose normal is the Z axis are mapped.

◆ source()

virtual void OdAveBitmap::source ( OdString &  filename)
pure virtual

Sets the source filename of this Bitmap object.

Parameters
filename[out] Receives the filename.

◆ tileMethod()

virtual OdAve::TileMethod OdAveBitmap::tileMethod ( )
pure virtual

Returns the tile method of this Bitmap object.

Remarks
Returns one of the following:

Value Description kTmDefault 0 Tiling as set for the material. kTmTile 1 Tiled. kTmCrop 2 Cropped. kTmClamp 3 Clamped.

◆ useAutoAxis()

virtual bool OdAveBitmap::useAutoAxis ( )
pure virtual

Returns true if and only if this Bitmap object uses Auto Axis.

Remarks
AutoAxis automatically maps materials to surfaces whose normals are the X, Y, and Z axes.

If AutoAxis is not used, only surfaces whose normal is the Z axis are mapped.

The documentation for this class was generated from the following file:
Generated on Mon Oct 12 2020 11:49:51