#include <GiRasterWrappers.h>

Inheritance diagram for OdGiRasterImageHolder:

Public Member Functions
	OdGiRasterImageHolder ()

virtual	~OdGiRasterImageHolder ()

void	setFrom (const OdGiRasterImage *pOrig)

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)

OdRxObjectPtr	clone () const

void	copyFrom (const OdRxObject *pSource)

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

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 OdRx::Ordering	comparedTo (const OdRxObject *pOther) const

virtual bool	isEqualTo (const OdRxObject *pOther) const

Static Public Member Functions
static OdGiRasterImagePtr	createObject (const OdGiRasterImage *pImage)

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 ()

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 class stores a full copy of original raster image data. Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 505 of file GiRasterWrappers.h.

Constructor & Destructor Documentation

◆ OdGiRasterImageHolder()

OdGiRasterImageHolder::OdGiRasterImageHolder ( )

◆ ~OdGiRasterImageHolder()

virtual OdGiRasterImageHolder::~OdGiRasterImageHolder ( )

virtual

Member Function Documentation

◆ clone()

OdRxObjectPtr OdGiRasterImageHolder::clone ( ) const

virtual

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

Reimplemented from OdRxObject.

◆ color()

ODCOLORREF OdGiRasterImageHolder::color ( OdUInt32 colorIndex ) const

virtual

Returns the color for the specified index from the palette of this RasterImage object.

Parameters

colorIndex [in] Color index.

Implements OdGiRasterImage.

◆ colorDepth()

OdUInt32 OdGiRasterImageHolder::colorDepth ( ) const

virtual

Returns the number of bits per pixel used for colors by this RasterImage object.

Implements OdGiRasterImage.

◆ copyFrom()

void OdGiRasterImageHolder::copyFrom ( const OdRxObject * pSource )

virtual

Copies data of a source object to the current object.

Parameters

pSource [in] Input source object.

Reimplemented from OdRxObject.

◆ createObject()

static OdGiRasterImagePtr OdGiRasterImageHolder::createObject ( const OdGiRasterImage * pImage )

static

Creates an OdGiRasterImageHolder object from an original OdGiRasterImage object.

Parameters

pImage [in] Pointer to the original image object.

Returns: Returns a SmartPointer to the newly created object.

◆ defaultResolution()

Units OdGiRasterImageHolder::defaultResolution	(	double &	xPelsPerUnit,
		double &	yPelsPerUnit
	)		const

virtual

Returns the default image resolution in pixels per unit of this RasterImage object.

Parameters

xPelsPerUnit	[out] Receives the pixels per unit value (x direction).
yPelsPerUnit	[out] Receives the pixels per unit value (y direction).

Remarks: If the returned value is kNone, then xPelsPerUnit and yPelsPerUnit are not set.

Reimplemented from OdGiRasterImage.

◆ imageSource()

ImageSource OdGiRasterImageHolder::imageSource ( ) const

virtual

Returns the image source.

Reimplemented from OdGiRasterImage.

◆ numColors()

OdUInt32 OdGiRasterImageHolder::numColors ( ) const

virtual

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

Implements OdGiRasterImage.

◆ paletteData()

void OdGiRasterImageHolder::paletteData ( OdUInt8 * bytes ) const

virtual

Returns the size (in bytes) of the palette data of this RasterImage object.

Implements OdGiRasterImage.

◆ paletteDataSize()

OdUInt32 OdGiRasterImageHolder::paletteDataSize ( ) const

virtual

Returns the size (in bytes) of the palette data of this RasterImage object.

Implements OdGiRasterImage.

◆ pixelFormat()

PixelFormatInfo OdGiRasterImageHolder::pixelFormat ( ) const

virtual

Returns the pixel format for this RasterImage object.

Remarks: This function returns the pixel format of the palette, unless there is no palette, in which case it returns the pixel format of the image itself.

Implements OdGiRasterImage.

◆ pixelHeight()

OdUInt32 OdGiRasterImageHolder::pixelHeight ( ) const

virtual

Returns the image height in pixels of this RasterImage object.

Implements OdGiRasterImage.

◆ pixelWidth()

OdUInt32 OdGiRasterImageHolder::pixelWidth ( ) const

virtual

Returns the image width in pixels of this RasterImage object.

Implements OdGiRasterImage.

◆ scanLines() [1/2]

const OdUInt8* OdGiRasterImageHolder::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.

Implements OdGiRasterImage.

◆ scanLines() [2/2]

void OdGiRasterImageHolder::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.

Implements OdGiRasterImage.

◆ scanLinesAlignment()

OdUInt32 OdGiRasterImageHolder::scanLinesAlignment ( ) const

virtual

Returns the scanline alignment, in bytes, for this RasterImage object. Example: scanLinesAlignment() returns 4 for Windows BMP.

Implements OdGiRasterImage.

◆ scanLineSize()

OdUInt32 OdGiRasterImageHolder::scanLineSize ( ) const

virtual

Returns the scanline size of this RasterImage object.

Remarks: This function returns the number of bytes between the beginning of scanline N and the beginning of scanline N+1 (taking into account any padding that is added to the end of the scanline).

Reimplemented from OdGiRasterImage.

◆ setFrom()

void OdGiRasterImageHolder::setFrom ( const OdGiRasterImage * pOrig )

Stores data from an original OdGiRasterImage object.

Parameters

pOrig [in] Pointer to the original image object.

◆ setImageSource()

void OdGiRasterImageHolder::setImageSource ( ImageSource source )

virtual

Sets an image source.

Parameters

source [in] New image source value.

Reimplemented from OdGiRasterImageParam.

◆ setSourceFileName()

void OdGiRasterImageHolder::setSourceFileName ( const OdString & fileName )

virtual

Sets an image source file name.

Parameters

fileName [in] New value for image source file name.

Reimplemented from OdGiRasterImageParam.

◆ setTransparencyMode()

void OdGiRasterImageHolder::setTransparencyMode ( TransparencyMode mode )

virtual

Sets an image transparency mode.

Parameters

mode	[in] New transparency mode value.

Reimplemented from OdGiRasterImageParam.

◆ sourceFileName()

const OdString& OdGiRasterImageHolder::sourceFileName ( ) const

virtual

Returns the image source file name.

Reimplemented from OdGiRasterImage.

◆ supportedParams()

OdUInt32 OdGiRasterImageHolder::supportedParams ( ) const

virtual

Returns the ParamType bitflags with which parameters are supported by this interface.

Implements OdGiRasterImageParam.

◆ transparencyMode()

TransparencyMode OdGiRasterImageHolder::transparencyMode ( ) const

virtual

Returns the transparency mode for 32bpp formats.

Reimplemented from OdGiRasterImage.

◆ transparentColor()

int OdGiRasterImageHolder::transparentColor ( ) const

virtual

Returns the index of transparent color in the image.

Remarks: If there is no transparent color, -1 should be returned. The default implementation of this function returns -1.

Reimplemented from OdGiRasterImage.

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

GiRasterWrappers.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OdGiRasterImageHolder()

◆ ~OdGiRasterImageHolder()

Member Function Documentation

◆ clone()

◆ color()

◆ colorDepth()

◆ copyFrom()

◆ createObject()

◆ defaultResolution()

◆ imageSource()

◆ numColors()

◆ paletteData()

◆ paletteDataSize()

◆ pixelFormat()

◆ pixelHeight()

◆ pixelWidth()

◆ scanLines() [1/2]

◆ scanLines() [2/2]

◆ scanLinesAlignment()

◆ scanLineSize()

◆ setFrom()

◆ setImageSource()

◆ setSourceFileName()

◆ setTransparencyMode()

◆ sourceFileName()

◆ supportedParams()

◆ transparencyMode()

◆ transparentColor()