AOI_Object_Raster Class Reference

Image. More...

Inheritance diagram for AOI_Object_Raster:

Public Member Functions
bool	IsMask () const
AOI_ColorSpacePtr	GetColorSpace () const
void	GetBitmapBounds (int32_t &width, int32_t &height) const
AOI_Object_BitmapPtr	GetBitmap () const
void	GetMapping (AOI_Mapping &) const
void	GetContour (AOI_ContourPtr) const
uint32_t	GetType () const
void	GetBounds (AOI_Rectangle &) const
AOI_Object *	GetNext () const
void	GetMaskedBounds (AOI_Rectangle &) const
void	GetPrecisionBounds (AOI_Rectangle &) const
AOI_BlendMode	GetBlendMode () const
float	GetBlendValue () const
AOI_Intent	GetIntent () const
bool	Visible () const
void	SetBlendMode (AOI_BlendMode)
void	SetBlendValue (float)
void	SetIntent (AOI_Intent)
void	Map (const AOI_Mapping &mapping)
void	Scale (const AOI_Mapping &)

Static Public Member Functions
static AOI_Object_Raster *	Create (AOI_Document *document, AOI_Object_Bitmap *bitmap)
static void	operator delete (void *)

Detailed Description

Image.

Definition at line 12 of file AOI_Raster.h.

Member Function Documentation

Create()

AOI_Object_Raster * AOI_Object_Raster::Create ( AOI_Document * document, AOI_Object_Bitmap * bitmap )

static

Creates a new empty AOI_Object_Raster object.

Parameters

document	The AOI_Document the image will be used in.
bitmap	The AOI_Object_Bitmap that will be used as image for this object.

Returns

The AOI_Object_Raster created.

Definition at line 15 of file AOI_Raster.cpp.

GetBitmap()

AOI_Object_BitmapPtr AOI_Object_Raster::GetBitmap

(

)

const

Retrieves the bitmap refered to by this raster. The bitmap can be shared by multiple raster objects. Every raster object shows the same bitmap at another location with other render settings.

Returns

BitmapT object

See also

AOI_Object_Bitmap

Definition at line 74 of file AOI_Raster.cpp.

GetBitmapBounds()

void AOI_Object_Raster::GetBitmapBounds	(	int32_t &	width,
		int32_t &	height ) const

Retrieves the width and height in pixels of the bitmap refered to by this raster.

Parameters

width	Variable to receive the width
height	Variable to receive the height

Definition at line 58 of file AOI_Raster.cpp.

GetBlendMode()

AOI_BlendMode AOI_Object::GetBlendMode ( ) const

inherited

Returns the BlendMode of the object.

Possible BlendModes are:

• eBMNormal
• eBMMultiply
• eBMScreen
• eBMOverlay
• eBMSoftLight
• eBMHardLight
• eBMColorDodge
• eBMColorBurn
• eBMDarken
• eBMLighten
• eBMDifference
• eBMExclusion
• eBMHue
• eBMSaturation
• eBMColor
• eBMLuminosity

Returns

The BlendMode.

Definition at line 132 of file AOI_Object.cpp.

GetBlendValue()

float AOI_Object::GetBlendValue ( ) const

inherited

Returns the value with which blending should be done. For normal blending this is the opacity value. 0 is transparent and 1 is opaque.

Returns

The BlendValue.

See also

GetBlendMode

Definition at line 145 of file AOI_Object.cpp.

GetBounds()

void AOI_Object::GetBounds ( AOI_Rectangle & r ) const

inherited

Returns the bounds of the object.

This function is quick and will suffice in most situations. It handles bezier curves by adding the complete hull to the bounds. For precise bounds use GetPrecisionBounds

Parameters

r	Receives the bounds

See also

GetPrecisionBounds GetMaskedBounds

Definition at line 40 of file AOI_Object.cpp.

GetColorSpace()

AOI_ColorSpacePtr AOI_Object_Raster::GetColorSpace

(

)

const

Returns the colorspace object defining the colorspace of the bitmap refered to by this raster.

Returns

Colorspace object

See also

AOI_ColorSpace

Definition at line 46 of file AOI_Raster.cpp.

GetContour()

void AOI_Object_Raster::GetContour

(

AOI_ContourPtr

ioContour

)

const

Retrieves the hard clipping mask as path(s) in the given contour. The contour must be created by the caller and is filled using this method.

Parameters

ioContour

The contour object to receive the clipping path(s)

Definition at line 101 of file AOI_Raster.cpp.

GetIntent()

AOI_Intent AOI_Object::GetIntent ( ) const

inherited

Returns the intent with which this object should be rendered.

Possible values:

• ePerceptual
• eRelativeColorimetric
• eSaturation
• eAbsoluteColorimetric

Returns

The intent.

Definition at line 161 of file AOI_Object.cpp.

GetMapping()

void AOI_Object_Raster::GetMapping

(

AOI_Mapping &

map

)

const

Retrieves the mapping used to map the bitmap to the page. The mapping is identity when every pixel represents 1 AOI unit and is shown in the top left corner of the page.

Parameters

map	The mapping object that will receive the mapping.

See also

AOI_Object::Map

Definition at line 88 of file AOI_Raster.cpp.

GetMaskedBounds()

void AOI_Object::GetMaskedBounds ( AOI_Rectangle & r ) const

inherited

Returns the bounds of the object, taking into account the clipping.

Parameters

r	Receives the bounds

See also

GetBounds GetPrecisionBounds

Definition at line 63 of file AOI_Object.cpp.

GetNext()

AOI_ObjectPtr AOI_Object::GetNext ( ) const

inherited

Returns the next object.

The objects are stored in a tree with parents and children. The next object is the next kid of a parent. If there are no more kids, NULL will be returned.

Returns

The next object.

Definition at line 104 of file AOI_Object.cpp.

GetPrecisionBounds()

void AOI_Object::GetPrecisionBounds ( AOI_Rectangle & r ) const

inherited

Returns the bounds of the object. Beziers are handled completely, unlike in GetBounds.

Parameters

r	Receives the bounds

See also

GetBounds GetMaskedBounds

Definition at line 52 of file AOI_Object.cpp.

GetType()

uint32_t AOI_Object::GetType ( ) const

inherited

Returns the type of the object.

Possible types are:

• gDimensionType
• gGroupType
• gRasterType
• gSymbolType
• gMultiSymbolType
• gEllipseType
• gPathType
• gMultigonType
• gRectangleType
• gTextType
• gPathTextType
• gGroupType
• gPlaceHolderType

Returns

The type of the object.

See also

AOI_Object_Bitmap AOI_Object_Dimension AOI_Object_Ellipse AOI_Object_Group AOI_Object_Layer AOI_Object_Multigon AOI_Object_MultiSymbol AOI_Object_Path AOI_Object_PathText AOI_Object_PlaceHolder AOI_Object_Raster AOI_Object_Rectangle AOI_Object_Symbol AOI_Object_Text AOI_Object_Vector

Definition at line 90 of file AOI_Object.cpp.

IsMask()

bool AOI_Object_Raster::IsMask

(

)

const

Returns if the bitmap object refered to by this raster object contains a mask and thus shows with transparency.

Returns

True if a mask is present.

See also

AOI_Bitmap::GetMaskRange, AOI_Bitmap::GetMaskImage

Definition at line 34 of file AOI_Raster.cpp.

Map()

void AOI_Object::Map ( const AOI_Mapping & mapping )

inherited

Maps the object.

Parameters

mapping

The mapping which should be applied to this object.

See also

AOI_Mapping, Scale

Definition at line 192 of file AOI_Object.cpp.

operator delete()

void AOI_Object::operator delete ( void * p )

staticinherited

Deletes the object, after removing it from the object tree.

Definition at line 181 of file AOI_Object.cpp.

Scale()

void AOI_Object::Scale ( const AOI_Mapping & mapping )

inherited

Scale the objects while retaining properties like line-width and dash distance proportional to the supplied scale.

Parameters

mapping

The mapping which should be applied to this object. The mapping should only contain a scale to avoid unwanted side effect.

See also

AOI_Mapping, Map

Definition at line 206 of file AOI_Object.cpp.

SetBlendMode()

void AOI_Object::SetBlendMode ( AOI_BlendMode blendmode )

inherited

Sets the object its blendmode.

Parameters

blendmode

The blend mode to use.

See also

AOI_BlendMode GetBlendMode

Definition at line 217 of file AOI_Object.cpp.

SetBlendValue()

void AOI_Object::SetBlendValue ( float blendValue )

inherited

Sets the object its blendmode.

Parameters

blendValue

The amount of opacity. For normal blending this is the opacity value. 0 is transparent and 1 is opaque.

See also

GetBlendValue

Definition at line 230 of file AOI_Object.cpp.

SetIntent()

void AOI_Object::SetIntent ( AOI_Intent intent )

inherited

Sets the object its blendmode.

Parameters

intent

Intent to be used to convert to the device when a ICC based colorspace is assigned to this object.

See also

GetIntent

Definition at line 242 of file AOI_Object.cpp.

Visible()

bool AOI_Object::Visible ( ) const

inherited

Returns if this object is visible.

Returns

The visibility.

Definition at line 171 of file AOI_Object.cpp.

---

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

• C:/Environments/desktop/Source/PDFEngine/OpenAPI/AOI_Raster.h
• C:/Environments/desktop/Source/PDFEngine/OpenAPI/AOI_Raster.cpp