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

#include <RasterProcessor.h>

Inheritance diagram for OdRasterConvertPE:
OdRxObject

Public Types

enum  AdjustmentsBehaviour { kDwgBehaviour = 0, kDgnBehaviour = 1 }
 

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdRasterConvertPE)
 
virtual OdGiRasterImagePtr convertImage (const OdGiRasterImage *pOrig, bool convertPaletteToRGB, double brightness=50.0, double contrast=50.0, double fade=0.0, ODCOLORREF backgroundColor=0, bool flipX=false, bool flipY=false, bool rotate90=false, const OdGiRasterImage *pDestDesc=0, bool transparency=false)=0
 
virtual void setAdjustmentsBehaviour (AdjustmentsBehaviour newBehaviour)=0
 
virtual AdjustmentsBehaviour adjustmentsBehaviour () 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

This class is the Raster Converter Protocol Extension class. Corresponding C++ library: RasterProcessor <group Other_Classes>

Definition at line 39 of file RasterProcessor.h.

Member Enumeration Documentation

◆ AdjustmentsBehaviour

Brightness, contrast, fade adjustments behaviour.

Remarks
kDwgBehaviour is default state for adjustments behaviour.
Enumerator
kDwgBehaviour 
kDgnBehaviour 

Definition at line 77 of file RasterProcessor.h.

Member Function Documentation

◆ adjustmentsBehaviour()

virtual AdjustmentsBehaviour OdRasterConvertPE::adjustmentsBehaviour ( ) const
pure virtual

Returns current adjustments behaviour state.

◆ convertImage()

virtual OdGiRasterImagePtr OdRasterConvertPE::convertImage ( const OdGiRasterImage pOrig,
bool  convertPaletteToRGB,
double  brightness = 50.0,
double  contrast = 50.0,
double  fade = 0.0,
ODCOLORREF  backgroundColor = 0,
bool  flipX = false,
bool  flipY = false,
bool  rotate90 = false,
const OdGiRasterImage pDestDesc = 0,
bool  transparency = false 
)
pure virtual

This function applies the specified raster conversions to the specified RasterImage object.

Remarks
These conversions include filtering, flips, resampling, resizing, rotations, and trimming.
Parameters
pOrig[in] Pointer to the original image.
convertPaletteToRGB[in] Convert palette to RGB.
brightness[in] Brightness. [0.0 .. 100.0].
contrast[in] Contrast. [0.0 .. 100.0].
fade[in] Fade. [0.0 .. 100.0].
backgroundColor[in] Background color.
flipX[in] Flip along the X-axis.
flipY[in] Flip along the Y-axis.
rotate90[in] Rotate 90° CCW.
pDestDesc[in] Pointer to the destination image description..
transparency[in] Make transparent.

◆ ODRX_DECLARE_MEMBERS()

OdRasterConvertPE::ODRX_DECLARE_MEMBERS ( OdRasterConvertPE  )

◆ setAdjustmentsBehaviour()

virtual void OdRasterConvertPE::setAdjustmentsBehaviour ( AdjustmentsBehaviour  newBehaviour)
pure virtual

Setup adjustments behaviour for next convertImage calls.

Parameters
newBehaviour[in] new adjustments behaviour state.

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