Aurelon Open API 8.1.1
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
AOI_Object_PlaceHolder Class Reference
PDF elements » Graphic objects

Template element. More...

Inheritance diagram for AOI_Object_PlaceHolder:
AOI_Object_Symbol AOI_Object

Public Member Functions

AOI_ObjectPtr GetObj () const
 
AOI_Mapping GetMapping () const
 
AOI_Style_ColorPtr GetColor () 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 void operator delete (void *)
 

Detailed Description

Template element.

Definition at line 10 of file AOI_PlaceHolder.h.

Member Function Documentation

◆ 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
rReceives the bounds
See also
GetPrecisionBounds GetMaskedBounds

Definition at line 40 of file AOI_Object.cpp.

◆ GetColor()

AOI_Style_ColorPtr AOI_Object_Symbol::GetColor ( ) const
inherited

Returns the overriding color of the symbol. If NULL is returned then the objects its original colors are rendered. If a color is returned the shape should be rendered using that color.

Returns
Color object or NULL

Definition at line 50 of file AOI_Symbol.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()

AOI_Mapping AOI_Object_Symbol::GetMapping ( ) const
inherited

Returns the mapping of the symbol.

Returns
the mapping

Definition at line 35 of file AOI_Symbol.cpp.

◆ GetMaskedBounds()

void AOI_Object::GetMaskedBounds ( AOI_Rectangle & r) const
inherited

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

Parameters
rReceives 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.

◆ GetObj()

AOI_Object * AOI_Object_Symbol::GetObj ( ) const
inherited

Returns the shared object tree this symbol object refers to.

Returns
Pointer to an object or a group object.

Definition at line 25 of file AOI_Symbol.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
rReceives 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.

◆ Map()

void AOI_Object::Map ( const AOI_Mapping & mapping)
inherited

Maps the object.

Parameters
mappingThe 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
mappingThe 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
blendmodeThe 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
blendValueThe 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
intentIntent 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 file: