Mako 7.3.0 API
IDOMTransparencyGroup Class Referenceabstract

IDOMTransparencyGroup interface. Analogous to PDF Transparency groups. More...

#include <idomgroup.h>

Inheritance diagram for IDOMTransparencyGroup:

Classes

class  Data
 Initialization data. More...
 

Public Member Functions

virtual float getOpacity () const =0
 Get the group alpha/opacity. More...
 
virtual void setOpacity (float opacity)=0
 Set the group opacity. More...
 
virtual eBlendMode getBlendMode () const =0
 Get the blend mode to be used for compositing this group with the backdrop. More...
 
virtual void setBlendMode (eBlendMode blendMode)=0
 Set the blend mode to be used for compositing this group with the backdrop. More...
 
virtual IDOMColorSpacePtr getColorSpace () const =0
 Get the group colorspace. More...
 
virtual void setColorSpace (const IDOMColorSpacePtr &colorSpace)=0
 Set the group colorspace. More...
 
virtual bool getIsIsolated () const =0
 Is the group an isolated group? See section 7.5.5 of the PDF 1.7 spec for details. More...
 
virtual void setIsIsolated (bool isolated)=0
 Set whether the group is isolated. See section 7.5.5 of the PDF 1.7 spec for details. More...
 
virtual bool getIsKnockout () const =0
 Is the group a knockout group? See section 7.5.5 of the PDF 1.7 spec for details. More...
 
virtual void setIsKnockout (bool knockout)=0
 Set whether the group is a knockout group. See section 7.5.5 of the PDF 1.7 spec for details. More...
 
virtual IDOMBrushPtr getOpacityMask () const =0
 Retrieves smart pointer to opacity mask. More...
 
virtual void setOpacityMask (const IDOMBrushPtr &ptrOpacityMask)=0
 Sets opacity mask. More...
 
- Public Member Functions inherited from IDOMGroup
virtual const FMatrixgetRenderTransform () const =0
 Retrieves render transform matrix of the Group and its children. More...
 
virtual void setRenderTransform (const FMatrix &matrix)=0
 Sets render transform matrix of the Group and its children. More...
 
virtual IDOMPathGeometryPtr getClip () const =0
 Retrieves smart pointer to the clip. More...
 
virtual void setClip (const IDOMPathGeometryPtr &ptrClip)=0
 Sets clip. More...
 
virtual JawsMako::IOptionalContentDetailsPtr getOptionalContentDetails () const =0
 Get the JawsMako Optional Content details, or NULL if the group is not subject to optional content. More...
 
virtual void setOptionalContentDetails (const JawsMako::IOptionalContentDetailsPtr &details)=0
 Set the JawsMako Optional Content details for the group, or NULL to remove. Note that this is only allowed for bare IDOMGroup objects and not for subclasses. Any attempt to set optional content details on any object that is not an IDOMGroup (getNodeType() is eDOMGroupNode) will result in an exception. Note that an IDOMGroup may have optional content details or marked content details, but not both. More...
 
virtual JawsMako::IMarkedContentDetailsPtr getMarkedContentDetails () const =0
 Get the JawsMako Marked Content details for this group, or NULL if the group is not marked. More...
 
virtual void setMarkedContentDetails (const JawsMako::IMarkedContentDetailsPtr &details)=0
 Set the JawsMako Marked Content details for this group, or NULL to remove. Note that this is only allowed for bare IDOMGroup objects and not for subclasses. Any attempt to set marked content details on any object that is not an IDOMGroup (getNodeType() is eDOMGroupNode) will result in an exception. Note that an IDOMGroup may have optional content details or marked content details, but not both. More...
 
- Public Member Functions inherited from IDOMNode
virtual ~IDOMNode ()
 virtual destructor
 
virtual DOMid getDOMid () const =0
 Retrieves the node ID. More...
 
virtual void setDOMid (DOMid id)=0
 Sets the node ID. More...
 
virtual eDOMNodeType getNodeType () const =0
 Retrieves the DOM node type. More...
 
virtual bool getProperty (const EDLSysString &propertyName, PValue &propertyValue) const =0
 Retrieves the value of a property. The EDL DOM node can store non-content or relationship information through the use of the "properties" feature of the node. The data is represented as key-value pairs; the key being a string and the value being an abstract container called a PValue. PValues can represent integers, strings, DOM nodes, and so on. More...
 
virtual void setProperty (const EDLSysString &propertyName, const PValue &propertyValue)=0
 Sets the value of a property. The EDL DOM node can store non-content or relationship information through the use of the "properties" feature of the node. The data is represented as key-value pairs; the key being a string and the value being an abstract container called a PValue. PValues can represent integers, strings, DOM nodes, and so on. More...
 
virtual void removeProperty (const EDLSysString &propertyName)=0
 Removes property. More...
 
virtual IEDLSysStringCollectionEnumPtr getPropertyCollectionEnum ()=0
 Retrieves a navigable list of the property names stored on this node. More...
 
virtual bool hasChildNodes () const =0
 Function that indicates whether this node is a parent to other nodes. More...
 
virtual IDOMNodePtr getParentNode () const =0
 Gets the parent node of this node. More...
 
virtual IDOMNodePtr getFirstChild () const =0
 Gets the first child node of this node. More...
 
virtual IDOMNodePtr getLastChild () const =0
 Gets the last child node of this node. More...
 
virtual IDOMNodePtr getNextChild (const IDOMNodePtr &child) const =0
 Gets the child node which follows the node passed in. More...
 
virtual IDOMNodePtr getPreviousChild (const IDOMNodePtr &child) const =0
 Gets the child node which precedes the node passed in. More...
 
virtual IDOMNodePtr getPreviousSibling () const =0
 Retrieves the node's previous sibling node. More...
 
virtual IDOMNodePtr getNextSibling () const =0
 Retrieves node's next sibling node. More...
 
virtual void appendChild (const IDOMNodePtr &child)=0
 Appends a node to the end of the node's child list. More...
 
virtual void insertChild (const IDOMNodePtr &ptrPreviousSibling, const IDOMNodePtr &child, bool bCheckComplete=true)=0
 Insert a child node after ptrPreviousSibling. More...
 
virtual IDOMNodePtr extractChild (const IDOMNodePtr &child)=0
 Extracts (that is, finds and removes) a child node from the node children. After extraction the child node is no longer a part of the DOM. If no node is specified, the first available node will be extracted from the node's children. More...
 
virtual void replaceChild (const IDOMNodePtr &oldChild, const IDOMNodePtr &newChild)=0
 Replaces the child node with another. More...
 
virtual bool isComplete () const =0
 Signals the completeness of the node.
A complete node is one that has no more children to be added to it. More...
 
virtual void setComplete ()=0
 Sets the node's completeness status to "true".
 
virtual IDOMNodeFlagsgetFlags ()=0
 Retrieves the node's flags property. More...
 
virtual void setParentNode (const IDOMNodePtr &ptrParent)=0
 Sets the parent node. More...
 
virtual void setPreviousSibling (const IDOMNodePtr &ptrPreviousSibling)=0
 Sets the previous sibling node. More...
 
virtual void setNextSibling (const IDOMNodePtr &ptrNextSibling)=0
 Sets the next sibling node. More...
 
virtual bool isAncestor (const IDOMNodePtr &ptrCandidate)=0
 Function tests whether a candidate node is a descendant of the node. More...
 
virtual FRect getBounds (bool applyTransform=true, bool applyClip=true)
 Find the conservative bounding box of the marking content of the node. More...
 
virtual bool copyNodeData (IDOMNode *pSourceNode)=0
 Copy the properties collection, the flags and the DOM ID from the given source node to this one. More...
 
virtual IDOMNodePtr cloneNode (IEDLClassFactory *pFactory) const =0
 Simpified node cloning. An exception of type IEDLError will be thrown on failure. More...
 
virtual IDOMNodePtr cloneTree (IEDLClassFactory *pFactory) const =0
 Clone the tree of nodes beginning at this node. An exception of type IEDLError will be thrown on failure. More...
 
virtual void cloneTreeAndAppend (IEDLClassFactory *pFactory, const IDOMNodePtr &dest) const =0
 Clone the tree of nodes beginning at this node, and append the result to the destination tree. More...
 
virtual void completeTree ()=0
 Mark the entire tree from this point as complete. You should not ordinarily need to call this function.
 
virtual void removeCompleteFlagFromTree ()=0
 Mark the entire tree from this point as complete.
 
virtual void findChildrenOfType (eDOMNodeType type, CDOMNodeVect &nodes, bool searchForms=false)=0
 Find all children of this node with the given type, appending to the given vector. Does not descend into brushes. More...
 
virtual void walkTree (WalkTreeFunc func, void *priv, bool descendIntoBrushes=false, bool descendIntoForms=false)=0
 Walk through the DOM calling a given function on each node. The function is allowed to: More...
 
virtual void notifyOnDestruct (NodeDeleteFunc func, void *priv)=0
 Register interest in being told when this node is about to be destroyed. More...
 
virtual void unregisterNotify (NodeDeleteFunc func, void *priv)=0
 Unregister interest in being told when this node is about to be destroyed. More...
 
- Public Member Functions inherited from IEDLObject
virtual const CClassIDgetClassID () const =0
 Returns class ID of IEDLObject. More...
 
virtual bool init (CClassParams *pData)
 The init() method is called to perform any post-construction initialization of an IEDLObject that has been created by the EDL class factory, before it is actually returned by the factory. More...
 
virtual bool clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
 Create a copy of EDLObject. More...
 
- Public Member Functions inherited from IRCObject
virtual void addRef () const =0
 Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
 
virtual bool decRef () const =0
 Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to. More...
 
virtual int32 getRefCount () const =0
 Retrieve the current reference count of the actual object pointed to. More...
 

Static Public Member Functions

static const CClassIDclassID ()
 Retrieves class id of IDOMTransparencyGroup. More...
 
static EDL_API IDOMTransparencyGroupPtr create (IEDLClassFactory *pFactory, const FMatrix &transform=FMatrix(), const IDOMPathGeometryPtr &clip=IDOMPathGeometryPtr(), float opacity=1.0f, const IDOMBrushPtr &opacityMask=IDOMBrushPtr(), eBlendMode blendMode=eBlendModeNormal, const IDOMColorSpacePtr &colorSpace=IDOMColorSpacePtr(), bool isolated=false, bool knockout=false)
 Simplified creation function for IDOMGroup. Throws an IEDLError exception on failure. More...
 
- Static Public Member Functions inherited from IDOMGroup
static EDL_API IDOMGroupPtr create (IEDLClassFactory *pFactory, const FMatrix &transform=FMatrix(), const IDOMPathGeometryPtr &clip=IDOMPathGeometryPtr())
 Simplified creation function for IDOMGroup. Throws an IEDLError exception on failure. More...
 
static const CClassIDclassID ()
 Retrieves class id of IDOMGroup. More...
 
- Static Public Member Functions inherited from IDOMNode
static EDL_API FMatrix effectiveTransformationOfNode (const IDOMNodePtr &node)
 Attempt to find the effective transformation matrix external to the specified node relative to either a containing page or ultimate parent. More...
 

Additional Inherited Members

- Protected Member Functions inherited from IRCObject
virtual ~IRCObject ()
 Virtual destructor.
 

Detailed Description

IDOMTransparencyGroup interface. Analogous to PDF Transparency groups.

Member Function Documentation

◆ classID()

static const CClassID& IDOMTransparencyGroup::classID ( )
inlinestatic

Retrieves class id of IDOMTransparencyGroup.

Returns
CClassID class id of the element

◆ create()

static EDL_API IDOMTransparencyGroupPtr IDOMTransparencyGroup::create ( IEDLClassFactory pFactory,
const FMatrix transform = FMatrix(),
const IDOMPathGeometryPtr &  clip = IDOMPathGeometryPtr(),
float  opacity = 1.0f,
const IDOMBrushPtr &  opacityMask = IDOMBrushPtr(),
eBlendMode  blendMode = eBlendModeNormal,
const IDOMColorSpacePtr &  colorSpace = IDOMColorSpacePtr(),
bool  isolated = false,
bool  knockout = false 
)
static

Simplified creation function for IDOMGroup. Throws an IEDLError exception on failure.

Parameters
pFactoryThe EDL class factory
transformThe desired render transform
clipThe desired clip
opacityThe desired opacity
opacityMaskThe desired opacity mask
blendModeThe desired blend mode
colorSpaceThe desired group color space
isolatedGroup isolated parameter
knockoutGroup knockout parameter
Returns
IDOMTransparencyGroupPtr A smart pointer to the new transprency group

◆ getBlendMode()

virtual eBlendMode IDOMTransparencyGroup::getBlendMode ( ) const
pure virtual

Get the blend mode to be used for compositing this group with the backdrop.

Returns
eBlendMode The blend mode

◆ getColorSpace()

virtual IDOMColorSpacePtr IDOMTransparencyGroup::getColorSpace ( ) const
pure virtual

Get the group colorspace.

Returns
IDOMColorSpacePtr The group color space or NULL of no colour space is present.

◆ getIsIsolated()

virtual bool IDOMTransparencyGroup::getIsIsolated ( ) const
pure virtual

Is the group an isolated group? See section 7.5.5 of the PDF 1.7 spec for details.

Returns
bool True if the group is isolated.

◆ getIsKnockout()

virtual bool IDOMTransparencyGroup::getIsKnockout ( ) const
pure virtual

Is the group a knockout group? See section 7.5.5 of the PDF 1.7 spec for details.

Returns
bool True if the group is isolated.

◆ getOpacity()

virtual float IDOMTransparencyGroup::getOpacity ( ) const
pure virtual

Get the group alpha/opacity.

Returns
float The group opacity.

◆ getOpacityMask()

virtual IDOMBrushPtr IDOMTransparencyGroup::getOpacityMask ( ) const
pure virtual

Retrieves smart pointer to opacity mask.

Returns
IDOMBrushPtr The opacity mask or NULL of no opacity mask is present.

◆ setBlendMode()

virtual void IDOMTransparencyGroup::setBlendMode ( eBlendMode  blendMode)
pure virtual

Set the blend mode to be used for compositing this group with the backdrop.

Parameters
blendModeThe blend mode for the group.

◆ setColorSpace()

virtual void IDOMTransparencyGroup::setColorSpace ( const IDOMColorSpacePtr &  colorSpace)
pure virtual

Set the group colorspace.

This is an optional entry in most circumstances, and may not be used in all situations. This is only used for the following situations:

  • If the group is isolated (optional)
  • If the group is used in a SoftMask Brush, with the soft mask using the luminosity of the group.

Not all color spaces can be used. See section 7.5.5 of the PDF 1.7 specification for further information.

Parameters
colorSpaceThe desired color space

◆ setIsIsolated()

virtual void IDOMTransparencyGroup::setIsIsolated ( bool  isolated)
pure virtual

Set whether the group is isolated. See section 7.5.5 of the PDF 1.7 spec for details.

Parameters
isolatedNew value of isolated

◆ setIsKnockout()

virtual void IDOMTransparencyGroup::setIsKnockout ( bool  knockout)
pure virtual

Set whether the group is a knockout group. See section 7.5.5 of the PDF 1.7 spec for details.

Parameters
knockoutNew value of knockout

◆ setOpacity()

virtual void IDOMTransparencyGroup::setOpacity ( float  opacity)
pure virtual

Set the group opacity.

Parameters
opacityThe desired opacity.

◆ setOpacityMask()

virtual void IDOMTransparencyGroup::setOpacityMask ( const IDOMBrushPtr &  ptrOpacityMask)
pure virtual

Sets opacity mask.

Parameters
ptrOpacityMaskSmart pointer to brush

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