AOI_Object_Group Class Reference

Group, mask and transparency group. More...

Inheritance diagram for AOI_Object_Group:

Classes
class	SoftMask
	SoftMask definition. More...

Public Member Functions
bool	HasMask () const
bool	HasHardMask () const
bool	HasSoftMask () const
void	GetHardMask (AOI_ContourPtr) const
SoftMask	GetSoftMask () const
bool	GetEOFill () const
bool	GetTransparencyGroup () const
bool	GetIsolated () const
bool	GetKnockOut () const
AOI_ObjectPtr	GetFirstChild () const
int32_t	InsertChild (AOI_ObjectPtr child, int32_t index)
void	AppendChild (AOI_ObjectPtr child)
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 void	operator delete (void *)

Detailed Description

Group, mask and transparency group.

Definition at line 12 of file AOI_Group.h.

Member Function Documentation

AppendChild()

void AOI_Object_Group::AppendChild

(

AOI_ObjectPtr

child

)

Appends the given object as child to the list. The last object is rendered last and appears at top.

Parameters

child

Pointer to the object to append.

Definition at line 199 of file AOI_Group.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.

GetEOFill()

bool AOI_Object_Group::GetEOFill

(

)

const

Returns the filling rule that applies to the direct group objects. Not the objects in the group, they have there onw properties.

Returns

True for Even/Off filling, False for Winding fill

Definition at line 126 of file AOI_Group.cpp.

GetFirstChild()

AOI_ObjectPtr AOI_Object_Group::GetFirstChild

(

)

const

Returns the first child object in the group and NULL if no child objects are contained in this group object.

Returns

Pointer to the first child object.

See also

AOI_Object::GetNext, AOI_Object::GetParent

Definition at line 173 of file AOI_Group.cpp.

GetHardMask()

void AOI_Object_Group::GetHardMask

(

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 92 of file AOI_Group.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.

GetIsolated()

bool AOI_Object_Group::GetIsolated

(

)

const

If the group is a transparency group this method returns if the group is treated using isolated rendering.

Returns

True when this group is rendered isolated.

See also

GetTransparencyGroup, GetKnockOut

Definition at line 149 of file AOI_Group.cpp.

GetKnockOut()

bool AOI_Object_Group::GetKnockOut

(

)

const

If the group is a transparency group this method returns if the group knocks out the backgroup during rendering.

Returns

True when this group knocks out the background.

See also

GetTransparencyGroup, GetIsolated

Definition at line 161 of file AOI_Group.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.

GetSoftMask()

AOI_Object_Group::SoftMask AOI_Object_Group::GetSoftMask

(

)

const

Returns the object that defines the soft mask if any. If no soft mask is defined then the content of the returned object contains NULL pointers.

Returns

Pointer to the object that defines the soft mask.

Definition at line 105 of file AOI_Group.cpp.

GetTransparencyGroup()

bool AOI_Object_Group::GetTransparencyGroup

(

)

const

Returns if this group is treated an a transparency group.

Returns

True when this is a transparency group.

See also

GetIsolated, GetKnockOut

Definition at line 137 of file AOI_Group.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.

HasHardMask()

bool AOI_Object_Group::HasHardMask

(

)

const

Returns if the group has a hard clipping mask defined.

Returns

True when a mask is set on the group.

Definition at line 70 of file AOI_Group.cpp.

HasMask()

bool AOI_Object_Group::HasMask

(

)

const

Returns if the group has a mask defined. This mask can be either a hard clipping mask or a soft mask.

Returns

True when a mask is set on the group.

Definition at line 60 of file AOI_Group.cpp.

HasSoftMask()

bool AOI_Object_Group::HasSoftMask

(

)

const

Returns if the group has a soft mask defined.

Returns

True when a mask is set on the group.

Definition at line 80 of file AOI_Group.cpp.

InsertChild()

int32_t AOI_Object_Group::InsertChild	(	AOI_ObjectPtr	child,
		int32_t	index )

Insert the given object as child at the given position. The first objects are rendered first thus appear at the bottom. When the index is larger than the number of objects the given object is appended to the object list.

Parameters

child	Pointer to the object to insert.
index	Index at which the object to insert. The object is insert before the object with the given index.

Returns

Index at which the object is inserted.

Definition at line 188 of file AOI_Group.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_Group.h
• C:/Environments/desktop/Source/PDFEngine/OpenAPI/AOI_Group.cpp