CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
OdGiTintRasterTransformer Class Reference

#include <GiRasterWrappers.h>

Inheritance diagram for OdGiTintRasterTransformer:
OdGiInversionRasterTransformer OdGiRasterImageWrapper OdGiRasterImageParam OdGiRasterImage OdRxObject

Public Member Functions

 OdGiTintRasterTransformer ()
 
virtual ~OdGiTintRasterTransformer ()
 
OdRxObjectPtr clone () const
 
void copyFrom (const OdRxObject *pSource)
 
- Public Member Functions inherited from OdGiInversionRasterTransformer
 OdGiInversionRasterTransformer ()
 
virtual ~OdGiInversionRasterTransformer ()
 
ODCOLORREF color (OdUInt32 colorIndex) const
 
void paletteData (OdUInt8 *bytes) const
 
void scanLines (OdUInt8 *scnLines, OdUInt32 firstScanline, OdUInt32 numLines=1) const
 
const OdUInt8 * scanLines () const
 
OdRxObjectPtr clone () const
 
void copyFrom (const OdRxObject *pSource)
 
- Public Member Functions inherited from OdGiRasterImageWrapper
 OdGiRasterImageWrapper ()
 
virtual ~OdGiRasterImageWrapper ()
 
void setOriginal (const OdGiRasterImage *pOrig)
 
const OdGiRasterImage * original () const
 
OdGiRasterImagePtr cloneOriginal () const
 
OdUInt32 pixelWidth () const
 
OdUInt32 pixelHeight () const
 
Units defaultResolution (double &xPelsPerUnit, double &yPelsPerUnit) const
 
OdUInt32 colorDepth () const
 
OdUInt32 numColors () const
 
ODCOLORREF color (OdUInt32 colorIndex) const
 
OdUInt32 paletteDataSize () const
 
void paletteData (OdUInt8 *bytes) const
 
OdUInt32 scanLineSize () const
 
void scanLines (OdUInt8 *scnLines, OdUInt32 firstScanline, OdUInt32 numLines=1) const
 
const OdUInt8 * scanLines () const
 
PixelFormatInfo pixelFormat () const
 
OdUInt32 scanLinesAlignment () const
 
int transparentColor () const
 
ImageSource imageSource () const
 
const OdString & sourceFileName () const
 
TransparencyMode transparencyMode () const
 
OdUInt32 supportedParams () const
 
void setImageSource (ImageSource source)
 
void setSourceFileName (const OdString &fileName)
 
void setTransparencyMode (TransparencyMode mode)
 
void * imp () const
 
OdRxObjectPtr clone () const
 
void copyFrom (const OdRxObject *pSource)
 
- Public Member Functions inherited from OdGiRasterImageParam
 ODRX_DECLARE_MEMBERS (OdGiRasterImageParam)
 
virtual OdUInt32 supportedParams () const =0
 
virtual void setImageSource (ImageSource source)
 
virtual void setSourceFileName (const OdString &fileName)
 
virtual void setTransparencyMode (TransparencyMode mode)
 
- Public Member Functions inherited from OdGiRasterImage
 ODRX_DECLARE_MEMBERS (OdGiRasterImage)
 
virtual OdUInt32 pixelWidth () const =0
 
virtual OdUInt32 pixelHeight () const =0
 
virtual Units defaultResolution (double &xPelsPerUnit, double &yPelsPerUnit) const
 
virtual OdUInt32 colorDepth () const =0
 
virtual OdUInt32 numColors () const =0
 
virtual int transparentColor () const
 
virtual ODCOLORREF color (OdUInt32 colorIndex) const =0
 
virtual OdUInt32 paletteDataSize () const =0
 
virtual void paletteData (OdUInt8 *bytes) const =0
 
virtual OdUInt32 scanLineSize () const
 
virtual const OdUInt8 * scanLines () const =0
 
virtual void scanLines (OdUInt8 *scnLines, OdUInt32 firstScanline, OdUInt32 numLines=1) const =0
 
virtual PixelFormatInfo pixelFormat () const =0
 
virtual OdUInt32 scanLinesAlignment () const =0
 
virtual ImageSource imageSource () const
 
virtual const OdString & sourceFileName () const
 
virtual TransparencyMode transparencyMode () const
 
OdSmartPtr< OdGiRasterImage > changeImageSource (ImageSource source, const OdChar *pFileName=NULL)
 
OdSmartPtr< OdGiRasterImage > changeSourceFileName (const OdString &fileName)
 
OdSmartPtr< OdGiRasterImage > changeTransparencyMode (TransparencyMode mode)
 
OdSmartPtr< OdGiRasterImage > convert (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) const
 
virtual OdSmartPtr< OdGiRasterImage > crop (OdUInt32 x, OdUInt32 y, OdUInt32 width, OdUInt32 height) const
 
virtual void * imp () const
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObject * queryX (const OdRxClass *pClass) const
 
virtual OdRxObject * x (const OdRxClass *pClass) const
 
virtual OdRxClass * isA () 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
 

Static Public Member Functions

static OdGiRasterImagePtr createObject (const OdGiRasterImage *pOrig, const ODCOLORREF &clrTint)
 
- Static Public Member Functions inherited from OdGiInversionRasterTransformer
static OdGiRasterImagePtr createObject (const OdGiRasterImage *pOrig)
 
- Static Public Member Functions inherited from OdGiRasterImage
static double millimetersInUnit (Units units)
 
static OdUInt32 calcBMPScanLineSize (OdUInt32 pixelWidth, int colorDepth)
 
static OdUInt32 calcColorMask (OdUInt8 numColorBits, OdUInt8 colorOffset=0)
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClass * desc ()
 

Protected Member Functions

virtual ODCOLORREF colorXform (ODCOLORREF color) const
 
virtual ODCOLORREF colorXform (ODCOLORREF color) const
 

Protected Attributes

double m_dRedScale
 
double m_dGreenScale
 
double m_dBlueScale
 

Additional Inherited Members

- Public Types inherited from OdGiRasterImageParam
enum  ParamType { kImageSource = (1 << 0) , kTransparencyMode = (1 << 1) , kSourceFileName = (1 << 2) }
 
- Public Types inherited from OdGiRasterImage
enum  Units {
  kNone = 0 , kMillimeter , kCentimeter , kMeter ,
  kKilometer , kInch , kFoot , kYard ,
  kMile , kMicroinches , kMils , kAngstroms ,
  kNanometers , kMicrons , kDecimeters , kDekameters ,
  kHectometers , kGigameters , kAstronomical , kLightYears ,
  kParsecs
}
 
enum  ImageSource {
  kUndefinedSource = -1 , kFromDwg = 0 , kFromOleObject = 1 , kFromRender = 2 ,
  kFromUnderlay = 10 , kFromImageBGRA32 = 11 , kFromPdfUnderlay = kFromOleObject , kFromFile = kFromDwg
}
 
enum  TransparencyMode { kTransparencyDef = -1 , kTransparencyOff = 0 , kTransparency1Bit = 1 , kTransparency8Bit = 2 }
 
typedef struct OdGiRasterImage::tagPixelFormatInfo PixelFormatInfo
 

Detailed Description

This raster image transformer class apply tint color to image.

Corresponding C++ library: TD_Gi

Remarks
Transforming an image does not affect the orignal. <group OdGi_Classes>
See also
<link gi_raster_images, Work with Raster Images>

Definition at line 1470 of file GiRasterWrappers.h.

Constructor & Destructor Documentation

◆ OdGiTintRasterTransformer()

OdGiTintRasterTransformer::OdGiTintRasterTransformer ( )

Default constructor for the OdGiTintRasterTransformer class. Sets red, green and blue scales to 1.0.

◆ ~OdGiTintRasterTransformer()

virtual OdGiTintRasterTransformer::~OdGiTintRasterTransformer ( )
virtual

Destructor for the OdGiTintRasterTransformer class.

Member Function Documentation

◆ clone()

OdRxObjectPtr OdGiTintRasterTransformer::clone ( ) const
virtual

Creates a clone of this object, and returns a pointer to the clone.

Returns
smart pointer to the cloned object.

Reimplemented from OdGiInversionRasterTransformer.

◆ colorXform()

virtual ODCOLORREF OdGiTintRasterTransformer::colorXform ( ODCOLORREF  color) const
protectedvirtual

Reimplemented from OdGiInversionRasterTransformer.

◆ copyFrom()

void OdGiTintRasterTransformer::copyFrom ( const OdRxObject *  pSource)
virtual

Copies data of a source object to the current object.

Parameters
pSource[in] Input source object.

Reimplemented from OdGiInversionRasterTransformer.

◆ createObject()

static OdGiRasterImagePtr OdGiTintRasterTransformer::createObject ( const OdGiRasterImage *  pOrig,
const ODCOLORREF &  clrTint 
)
static

Creates a new tint image transformer.

Parameters
pOrig[in] Original raster image pointer.
clrTint[in] Tint color value that is used to set corresponding scales for separate color channels.

Member Data Documentation

◆ m_dBlueScale

double OdGiTintRasterTransformer::m_dBlueScale
protected

Definition at line 1506 of file GiRasterWrappers.h.

◆ m_dGreenScale

double OdGiTintRasterTransformer::m_dGreenScale
protected

Definition at line 1505 of file GiRasterWrappers.h.

◆ m_dRedScale

double OdGiTintRasterTransformer::m_dRedScale
protected

Definition at line 1504 of file GiRasterWrappers.h.


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