#include <GiRasterWrappers.h>

Inheritance diagram for OdGiRasterImageAlphaChannelAdder:

Public Member Functions
	OdGiRasterImageAlphaChannelAdder ()

virtual	~OdGiRasterImageAlphaChannelAdder ()

OdUInt32	scanLineSize () const

const OdUInt8 *	scanLines () const

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

OdUInt32	pixelWidth () const

OdUInt32	pixelHeight () const

OdUInt32	colorDepth () const

OdUInt32	numColors () const

ODCOLORREF	color (OdUInt32 colorIndex) const

OdUInt32	paletteDataSize () const

void	paletteData (OdUInt8 *bytes) const

OdGiRasterImage::PixelFormatInfo	pixelFormat () const

OdUInt32	scanLinesAlignment () const

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

OdUInt32	supportedParams () const

OdGiRasterImage::ImageSource	imageSource () const

OdGiRasterImage::TransparencyMode	transparencyMode () const

void	setTransparencyMode (OdGiRasterImage::TransparencyMode mode)

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, ODCOLORREF cutColor, OdUInt8 threshold=0)

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
OdUInt8	getAlphaValue (OdUInt8 red, OdUInt8 green, OdUInt8 blue) const

Protected Attributes
const OdGiRasterImage *	m_pOrigImage

ODCOLORREF	m_clPixelAlpha

OdUInt8	m_nPixelAlphaThreshold

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

Extends the original OdGiRasterImage with alpha channel data.

Remarks: Stores only a pointer to the original image, not a SmartPointer, so deletion of the original image before this class may cause an access violation error. Corresponding C++ library: TD_Gi <group OdGi_Classes>

See also: <link gi_raster_images, Work with Raster Images>

Definition at line 1579 of file GiRasterWrappers.h.

Constructor & Destructor Documentation

◆ OdGiRasterImageAlphaChannelAdder()

OdGiRasterImageAlphaChannelAdder::OdGiRasterImageAlphaChannelAdder ( )

Default constructor for the OdGiRasterImageAlphaChannelAdder class. Sets the following data members:

Value Description m_pOrigImage NULL Pointer to an original image. m_clPixelAlpha ODRGB( 0, 0, 0 ) Alpha pixel color. m_nPixelAlphaThreshold 0 Alpha pixel color threshold.

◆ ~OdGiRasterImageAlphaChannelAdder()

virtual OdGiRasterImageAlphaChannelAdder::~OdGiRasterImageAlphaChannelAdder ( )

virtual

Destructor for the OdGiRasterImageAlphaChannelAdder class.

Member Function Documentation

◆ clone()

OdRxObjectPtr OdGiRasterImageAlphaChannelAdder::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 OdRxObject.

◆ color()

ODCOLORREF OdGiRasterImageAlphaChannelAdder::color ( OdUInt32 colorIndex ) const

virtual

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

Parameters

colorIndex [in] Color index.

Returns: color at the specified index as ODCOLORREF (OdUInt32) value.

Implements OdGiRasterImage.

◆ colorDepth()

OdUInt32 OdGiRasterImageAlphaChannelAdder::colorDepth ( ) const

virtual

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

Returns: number of bits per pixel that represents color depth.

Implements OdGiRasterImage.

◆ copyFrom()

void OdGiRasterImageAlphaChannelAdder::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 OdGiRasterImageAlphaChannelAdder::createObject	(	const OdGiRasterImage *	pOrig,
		ODCOLORREF	cutColor,
		OdUInt8	threshold = `0`
	)

static

Creates an OdGiRasterImageAlphaChannelAdder object with the specified parameters.

Parameters

pOrig	[in] Input original image.
cutColor	[in] Alpha pixel color.
threshold	[in] Alpha pixel color threshold.

Returns: Returns a SmartPointer to the newly created object.

◆ defaultResolution()

OdGiRasterImage::Units OdGiRasterImageAlphaChannelAdder::defaultResolution	(	double &	xPelsPerUnit,
		double &	yPelsPerUnit
	)		const

virtual

Retrieves 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).

Returns: units that are used to measure image dimensions.

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

Reimplemented from OdGiRasterImage.

◆ getAlphaValue()

OdUInt8 OdGiRasterImageAlphaChannelAdder::getAlphaValue	(	OdUInt8	red,
		OdUInt8	green,
		OdUInt8	blue
	)		const

protected

◆ imageSource()

OdGiRasterImage::ImageSource OdGiRasterImageAlphaChannelAdder::imageSource ( ) const

virtual

Retrieves the image source.

Returns: image source represented by a value from the OdGiRasterImage::ImageSource enumeration.

Reimplemented from OdGiRasterImage.

◆ numColors()

OdUInt32 OdGiRasterImageAlphaChannelAdder::numColors ( ) const

virtual

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

Returns: number of colors in the palette.

Implements OdGiRasterImage.

◆ paletteData()

void OdGiRasterImageAlphaChannelAdder::paletteData ( OdUInt8 * bytes ) const

virtual

Retrieves the palette in BMP format of this RasterImage object.

Parameters

bytes [out] Receives the palette data.

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

Implements OdGiRasterImage.

◆ paletteDataSize()

OdUInt32 OdGiRasterImageAlphaChannelAdder::paletteDataSize ( ) const

virtual

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

Returns: number of bytes that represents palette data size.

Implements OdGiRasterImage.

◆ pixelFormat()

OdGiRasterImage::PixelFormatInfo OdGiRasterImageAlphaChannelAdder::pixelFormat ( ) const

virtual

Retrieves the pixel format for this RasterImage object.

Returns: the pixel format of the palette, unless there is no palette, in which case it returns the pixel format of the image itself. Returns BGRA pixel format.

Implements OdGiRasterImage.

◆ pixelHeight()

OdUInt32 OdGiRasterImageAlphaChannelAdder::pixelHeight ( ) const

virtual

Retrieves the image height in pixels of this RasterImage object.

Returns: image height in pixels.

Implements OdGiRasterImage.

◆ pixelWidth()

OdUInt32 OdGiRasterImageAlphaChannelAdder::pixelWidth ( ) const

virtual

Retrieves the image width in pixels of this RasterImage object.

Returns: image width in pixels.

Implements OdGiRasterImage.

◆ scanLines() [1/2]

const OdUInt8 * OdGiRasterImageAlphaChannelAdder::scanLines ( ) const

virtual

Retrieves the set of scanlines.

Returns: NULL.

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 OdGiRasterImageAlphaChannelAdder::scanLines	(	OdUInt8 *	scnLines,
		OdUInt32	firstScanline,
		OdUInt32	numLines = `1`
	)		const

virtual

Retrieves 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 OdGiRasterImageAlphaChannelAdder::scanLinesAlignment ( ) const

virtual

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

Returns: scan lines alignment which is 4 for this object.

Implements OdGiRasterImage.

◆ scanLineSize()

OdUInt32 OdGiRasterImageAlphaChannelAdder::scanLineSize ( ) const

virtual

Retrieves 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.

◆ setTransparencyMode()

void OdGiRasterImageAlphaChannelAdder::setTransparencyMode ( OdGiRasterImage::TransparencyMode mode )

virtual

Sets an image transparency mode.

Parameters

mode	[in] New transparency mode value.

Reimplemented from OdGiRasterImageParam.

◆ supportedParams()

OdUInt32 OdGiRasterImageAlphaChannelAdder::supportedParams ( ) const

virtual

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

Returns: bitflags that represent supported parameters.

Implements OdGiRasterImageParam.

◆ transparencyMode()

OdGiRasterImage::TransparencyMode OdGiRasterImageAlphaChannelAdder::transparencyMode ( ) const

virtual

Retrieves the transparency mode for 32bpp formats.

Returns: transparency mode represented by a value from the OdGiRasterImage::TransparencyMode enumeration.

Reimplemented from OdGiRasterImage.

Member Data Documentation

◆ m_clPixelAlpha

ODCOLORREF OdGiRasterImageAlphaChannelAdder::m_clPixelAlpha

protected

Definition at line 1583 of file GiRasterWrappers.h.

◆ m_nPixelAlphaThreshold

OdUInt8 OdGiRasterImageAlphaChannelAdder::m_nPixelAlphaThreshold

protected

Definition at line 1584 of file GiRasterWrappers.h.

◆ m_pOrigImage

const OdGiRasterImage* OdGiRasterImageAlphaChannelAdder::m_pOrigImage

protected

Definition at line 1582 of file GiRasterWrappers.h.

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

GiRasterWrappers.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OdGiRasterImageAlphaChannelAdder()

◆ ~OdGiRasterImageAlphaChannelAdder()

Member Function Documentation

◆ clone()

◆ color()

◆ colorDepth()

◆ copyFrom()

◆ createObject()

◆ defaultResolution()

◆ getAlphaValue()

◆ imageSource()

◆ numColors()

◆ paletteData()

◆ paletteDataSize()

◆ pixelFormat()

◆ pixelHeight()

◆ pixelWidth()

◆ scanLines() [1/2]

◆ scanLines() [2/2]

◆ scanLinesAlignment()

◆ scanLineSize()

◆ setTransparencyMode()

◆ supportedParams()

◆ transparencyMode()

Member Data Documentation

◆ m_clPixelAlpha

◆ m_nPixelAlphaThreshold

◆ m_pOrigImage