OdGiInversionRasterTransformer Class Reference

#include <GiRasterWrappers.h>

Inheritance diagram for OdGiInversionRasterTransformer:

Public Member Functions
	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
OdUInt32	paletteDataSize () const
OdUInt32	scanLineSize () 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
Public Member Functions inherited from OdGiRasterImageParam
	ODRX_DECLARE_MEMBERS (OdGiRasterImageParam)
Public Member Functions inherited from OdGiRasterImage
	ODRX_DECLARE_MEMBERS (OdGiRasterImage)
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
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 OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Static Public Member Functions
static OdGiRasterImagePtr	createObject (const OdGiRasterImage *pOrig)
Static Public Member Functions inherited from OdGiRasterImage
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

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 negates image colors.

Corresponding C++ library: TD_Gi

Remarks

Transforming an image does not affect the orignal.

<group OdGi_Classes>

Definition at line 1078 of file GiRasterWrappers.h.

Constructor & Destructor Documentation

OdGiInversionRasterTransformer()

OdGiInversionRasterTransformer::OdGiInversionRasterTransformer

(

)

~OdGiInversionRasterTransformer()

virtual OdGiInversionRasterTransformer::~OdGiInversionRasterTransformer ( )

virtual

Member Function Documentation

clone()

OdRxObjectPtr OdGiInversionRasterTransformer::clone ( ) const

virtual

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

Reimplemented from OdGiRasterImageWrapper.

Reimplemented in OdGiMonochromaticRasterTransformer, and OdGiGrayscaleRasterTransformer.

color()

ODCOLORREF OdGiInversionRasterTransformer::color ( OdUInt32  colorIndex ) const

virtual

Returns the number of colors in the palette of this RasterImage object.

Parameters

colorIndex

[in] Color index.

Reimplemented from OdGiRasterImageWrapper.

colorXform()

virtual ODCOLORREF OdGiInversionRasterTransformer::colorXform ( ODCOLORREF  color ) const

protectedvirtual

Reimplemented in OdGiMonochromaticRasterTransformer, and OdGiGrayscaleRasterTransformer.

copyFrom()

void OdGiInversionRasterTransformer::copyFrom ( const OdRxObject *  pSource )

virtual

Copies data of a source object to the current object.

Parameters

pSource

[in] Input source object.

Reimplemented from OdGiRasterImageWrapper.

Reimplemented in OdGiMonochromaticRasterTransformer, and OdGiGrayscaleRasterTransformer.

createObject()

static OdGiRasterImagePtr OdGiInversionRasterTransformer::createObject ( const OdGiRasterImage *  pOrig )

static

Creates a new inversion image transformer.

Parameters

pOrig

[in] Original raster image pointer.

paletteData()

void OdGiInversionRasterTransformer::paletteData ( OdUInt8 *  bytes ) const

virtual

Returns the palette in BMP format of this RasterImage object.

Parameters

bytes

[out] Output palette data.

Remarks

It is up to the caller to allocate sufficient memory for the palette data.

Reimplemented from OdGiRasterImageWrapper.

scanLines() [1/2]

const OdUInt8* OdGiInversionRasterTransformer::scanLines ( ) const

virtual

Returns the set of scanlines.

Remarks

Implementation of this function is optional; NULL can be returned if it is inconvenient to implement. The caller must take into account that the return value can be NULL. If this method returns NULL, scanlines can be accessed by a second version of the scanLines() method with arguments where a memory buffer for scalines data is preallocated by the caller.

Reimplemented from OdGiRasterImageWrapper.

scanLines() [2/2]

void OdGiInversionRasterTransformer::scanLines ( OdUInt8 *  scnLines, OdUInt32  firstScanline, OdUInt32  numLines = 1  ) const

virtual

Returns the specified set of scanlines in BMP format for this RasterImage object, or the pixel data in BMP format for this RasterImage object.

Parameters

scnLines	[out] Receives the scanline data.
firstScanline	[in] Index of first scanline to retrieve.
numLines	[in] Number of scanlines to retrieve.

Remarks

The number of accessible scanlines is equal to the value returned by pixelHeight(). The number of accessible bytes in a scanline is equal to the value returned by scanLineSize(). The scanline returned by firstScanline == 0 is the first scanline in the image. The scanline returned by firstScanline == (pixelHeight() - 1) is the last scanline in the image.

It us up to the caller to allocate sufficient memory for the scanline data.

Reimplemented from OdGiRasterImageWrapper.

---

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

• GiRasterWrappers.h