OdGiRasterImageParam Class Reference

#include <GiRasterImage.h>

Inheritance diagram for OdGiRasterImageParam:

Public Types
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

Public Member Functions
	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

Additional Inherited Members
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 ()

Detailed Description

This interface simply extends GiRasterImage to set the image source and transparency mode values. If the raster image can be cast to this interface, values will be set within this interface; otherwise the raster image wrapper will be created to reset these values. Corresponding C++ library: TD_Gi <group OdGi_Classes>

Definition at line 473 of file GiRasterImage.h.

Member Enumeration Documentation

ParamType

enum OdGiRasterImageParam::ParamType

Enumerator
kImageSource
kTransparencyMode
kSourceFileName

Definition at line 478 of file GiRasterImage.h.

Member Function Documentation

ODRX_DECLARE_MEMBERS()

OdGiRasterImageParam::ODRX_DECLARE_MEMBERS

(

OdGiRasterImageParam

)

setImageSource()

virtual void OdGiRasterImageParam::setImageSource ( ImageSource  source )

inlinevirtual

Sets an image source.

Parameters

source

[in] New image source value.

Reimplemented in OdGiRasterImageDesc, OdGiRasterImageWrapper, and OdGiRasterImageHolder.

Definition at line 494 of file GiRasterImage.h.

setSourceFileName()

virtual void OdGiRasterImageParam::setSourceFileName ( const OdString &  fileName )

inlinevirtual

Sets an image source file name.

Parameters

fileName

[in] New value for image source file name.

Reimplemented in OdGiRasterImageWrapper, OdGiRasterImageHolder, and OdGiRasterImageDesc.

Definition at line 500 of file GiRasterImage.h.

setTransparencyMode()

virtual void OdGiRasterImageParam::setTransparencyMode ( TransparencyMode  mode )

inlinevirtual

Sets an image transparency mode.

Parameters

mode	[in] New transparency mode value.

Reimplemented in OdGiRasterImageWrapper, OdGiRasterImageHolder, OdGiRasterImageAlphaChannelAdder, OdGiRasterImageBGRA32, and OdGiRasterImageDesc.

Definition at line 506 of file GiRasterImage.h.

supportedParams()

virtual OdUInt32 OdGiRasterImageParam::supportedParams ( ) const

pure virtual

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

Implemented in OdGiRasterImageAlphaChannelAdder, OdGiRasterImageWrapper, OdGiRasterImageHolder, OdGiRasterImageBGRA32, and OdGiRasterImageDesc.

---

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

• GiRasterImage.h