Mako 7.5.0 API
Loading...
Searching...
No Matches
IDOMMaskedBrush Class Referenceabstract

IDOMMaskedBrush interface, this describes a generalization of a masked image. The sub-brush (set by getBrush()/setBrush()) is painted through a mask specified by the image. Importantly, the sub-brush is not subject to the IDOMImageBrush render transform. Tiling is not supported for this brush type. More...

#include <idombrush.h>

Inheritance diagram for IDOMMaskedBrush:

Classes

class  Data
 Initialization data. More...
 

Public Member Functions

virtual IDOMBrushPtr getBrush () const =0
 Retrieves smart pointer to the brush to be painted through the image.
 
virtual void setBrush (const IDOMBrushPtr &brush)=0
 Sets brush.
 
virtual bool getIsSoftMask (IEDLClassFactory *pFactory)=0
 Is the mask a soft mask? That is, is the mask not a single bit image? An outright error will result in an exception of type IEDLError.
 
virtual IDOMBrushPtr getEquivalentXPSBrush (IEDLClassFactory *pFactory, const FRect &enclosedBounds)=0
 Gets an equivalent image or visual brush that can be used to express this masked brush in XPS compatible form. This does not guarantee that the sub brush can be represented in XPS; these ought to be processed first. To do this, the bounds of the enclosing object in internal space must be provided (that is, the coordinate space effective inside that object).
 
virtual IDOMImageBrushPtr getSimpleImageBrush (IEDLClassFactory *pFactory)=0
 Attempts to create a single IDOMImageBrush that representes the masked result. This can be achieved if the brush masked by the image is a solid color brush, or if the brush masked by the image is an image with the same dimensions. Returns NULL if such a brush isn't possible, and throws an IEDLError exception on outright failures.
 
- Public Member Functions inherited from IDOMImageBrush
virtual eTilingMode getTileMode () const =0
 Retrieves the tiling mode value of the image brush.
 
virtual void setTileMode (eTilingMode tm)=0
 Sets the tiling mode of the image brush.
 
virtual eViewUnits getViewBoxUnits () const =0
 Retrieves the viewbox units used by the image brush. Currently, only absolute units are supported.
 
virtual void setViewBoxUnits (eViewUnits vu)=0
 Sets the viewbox units value of the image brush. Currently, only absolute units are supported.
 
virtual eViewUnits getViewPortUnits () const =0
 Retrieves the viewport units value of the image brush. Currently, only absolute units are supported.
 
virtual void setViewPortUnits (eViewUnits vu)=0
 Sets the viewport units used for the image brush. Currently, only absolute units are supported.
 
virtual const FRect & getViewBox () const =0
 Retrieves the viewbox rectangle.
 
virtual void setViewBox (const FRect &vb)=0
 Sets the viewbox rectangle.
 
virtual const FRect & getViewPort () const =0
 Retrieves the viewport rectangle.
 
virtual void setViewPort (const FRect &vp)=0
 Sets the viewport rectangle.
 
virtual IDOMICCProfilePtr getICCProfile () const =0
 Retrieves the external ICC profile of the brush if present.
 
virtual void setICCProfile (const IDOMICCProfilePtr &icc)=0
 Retrieves the external ICC profile of the brush if present.
 
virtual IDOMImagePtr getImageSource () const =0
 Retrieves a smart pointer to the image resource.
 
virtual void setImageSource (const IDOMImagePtr &ptrImageSource)=0
 Sets the image resource for the brush.
 
virtual CDOMAlternateImageVect getAlternateImages () const =0
 Retrieves any alternate images associated with this brush.
 
virtual void setAlternateImages (const CDOMAlternateImageVect &alternates)=0
 Set the alternate images associated with this brush.
 
virtual JawsMako::IOptionalContentDetailsPtr getOptionalContentDetails () const =0
 Returns any optional content information that applies to this brush.
 
virtual void setOptionalContentDetails (const JawsMako::IOptionalContentDetailsPtr &details)=0
 Set the optional content details that apply to this brush, or NULL to remove.
 
virtual JawsMako::IPDFDictionaryPtr getPdfPropertiesDictionary () const =0
 Get the dictionary containing PDF properties attached to the image object. This dictionary will be as per the XObject dictionary in the original PDF, but with entries handled by existing DOM features stripped. In particular, the following entries described in the PDF specification will not be present in the dictionary:
 
virtual void setPdfPropertiesDictionary (const JawsMako::IPDFDictionaryPtr &propertiesDictionary)=0
 Set the dictionary containing PDF properties attached to the image object. Please see getPdfPropertiesDictionary() above for information on the form of this dictionary.
 
virtual IDOMTilingPatternBrushPtr getEquivalentTilingBrush (IEDLClassFactory *pFactory)=0
 Gets an equivalent IDOMTilingPattern brush. If the receiver has a tile mode of eNoTile, this call will fail.
 
virtual IDOMVisualBrushPtr getEquivalentVisualBrush (IEDLClassFactory *pFactory)=0
 For tiled images, returns an equivalent visual brush containing the image without tiling. Will throw an exception if the image is not tiled. Not available for masked brushes as tiling is not supported for those brushes.
 
- Public Member Functions inherited from IDOMTransformableBrush
virtual const FMatrixgetRenderTransform () const =0
 Retrieves the render transform matrix.
 
virtual void setRenderTransform (const FMatrix &matrix)=0
 Sets the render transform matrix.
 
- Public Member Functions inherited from IDOMBrush
virtual eBrushType getBrushType () const =0
 Retrieves the type of the brush.
 
virtual float getOpacity () const =0
 Retrieves the opacity value of the brush element.
 
virtual void setOpacity (float opc)=0
 Sets the opacity value of a brush element.
 
virtual IDOMBrushPtr getAdjustedForUseInTransformedNode (IEDLClassFactory *pFactory, const FMatrix &nodeTransform)
 Get a version of this brush adjusted for use inside a node with the given transform.
 
- Public Member Functions inherited from IEDLObject
virtual const CClassIDgetClassID () const =0
 Returns class ID of IEDLObject.
 
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.
 
virtual bool clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
 Create a copy of EDLObject.
 
- 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.
 
virtual int32 getRefCount () const =0
 Retrieve the current reference count of the actual object pointed to.
 
- Public Member Functions inherited from IDOMHashable
virtual ~IDOMHashable ()
 Virtual destructor.
 
virtual bool hash (uint64 &hash)=0
 Retrieve a hash for this object.
 
virtual uint64 hashE ()
 As hash(), but throws an exception if the operation fails.
 

Static Public Member Functions

static EDL_API IDOMMaskedBrushPtr create (IEDLClassFactory *pFactory, const IDOMImagePtr &mask, const IDOMBrushPtr &brush, const FRect &viewBox, const FRect &viewPort, const FMatrix &renderTransform=FMatrix(), float opacity=1.0f, const CDOMAlternateImageVect &alternateImages=CDOMAlternateImageVect(), const JawsMako::IOptionalContentDetailsPtr &optionalContentDetails=JawsMako::IOptionalContentDetailsPtr(), const JawsMako::IPDFDictionaryPtr &propertiesDictionary=JawsMako::IPDFDictionaryPtr())
 Simplified creator for a masked brush. Throws an IEDLError on failure.
 
static const CClassIDclassID ()
 Retrieves class id of IDOM.
 
- Static Public Member Functions inherited from IDOMImageBrush
static EDL_API IDOMImageBrushPtr create (IEDLClassFactory *pFactory, const IDOMImagePtr &image, const FRect &viewBox, const FRect &viewPort, const FMatrix &renderTransform=FMatrix(), float opacity=1.0f, eTilingMode tileMode=eNoTile, const CDOMAlternateImageVect &alternateImages=CDOMAlternateImageVect(), const JawsMako::IOptionalContentDetailsPtr &optionalContentDetails=JawsMako::IOptionalContentDetailsPtr(), const JawsMako::IPDFDictionaryPtr &propertiesDictionary=JawsMako::IPDFDictionaryPtr())
 Simplified creator for an image brush. Throws an IEDLError on failure.
 
static const CClassIDclassID ()
 Retrieves class id of IDOM.
 

Additional Inherited Members

- Public Types inherited from IDOMBrush
enum  eBrushType {
  eSolidColor , eLinearGradient , eRadialGradient , eImage ,
  eMasked , eVisual , eSoftMask , eTilingPattern ,
  eType1ShadingPattern , eType2ShadingPattern , eType3ShadingPattern , eType4567ShadingPattern ,
  eNull
}
 Brush type enumeration. More...
 
- Protected Member Functions inherited from IRCObject
virtual ~IRCObject ()
 Virtual destructor.
 

Detailed Description

IDOMMaskedBrush interface, this describes a generalization of a masked image. The sub-brush (set by getBrush()/setBrush()) is painted through a mask specified by the image. Importantly, the sub-brush is not subject to the IDOMImageBrush render transform. Tiling is not supported for this brush type.

Member Function Documentation

◆ classID()

static const CClassID & IDOMMaskedBrush::classID ( )
inlinestatic

Retrieves class id of IDOM.

Returns
CClassID Class id of the element

◆ create()

static EDL_API IDOMMaskedBrushPtr IDOMMaskedBrush::create ( IEDLClassFactory * pFactory,
const IDOMImagePtr & mask,
const IDOMBrushPtr & brush,
const FRect & viewBox,
const FRect & viewPort,
const FMatrix & renderTransform = FMatrix(),
float opacity = 1.0f,
const CDOMAlternateImageVect & alternateImages = CDOMAlternateImageVect(),
const JawsMako::IOptionalContentDetailsPtr & optionalContentDetails = JawsMako::IOptionalContentDetailsPtr(),
const JawsMako::IPDFDictionaryPtr & propertiesDictionary = JawsMako::IPDFDictionaryPtr() )
static

Simplified creator for a masked brush. Throws an IEDLError on failure.

Parameters
pFactoryThe factory to use.
maskThe image mask to use.
brushThe brush to use
viewBoxThe desired view box. If empty, the viewPort will be set to the full area of the image.
viewPortThe desired view port.
renderTransformThe desired render transform.
opacityThe desired brush opacity.
alternateImagesA vector containing alternate images.
optionalContentDetailsAny optional content details to be applied to this masked case
propertiesDictionaryDictionary containing any additional PDF properties
Returns
IDOMMaskedBrushPtr The new brush.

◆ getBrush()

virtual IDOMBrushPtr IDOMMaskedBrush::getBrush ( ) const
pure virtual

Retrieves smart pointer to the brush to be painted through the image.

Returns
IDOMBrushPtr The brush

◆ getEquivalentXPSBrush()

virtual IDOMBrushPtr IDOMMaskedBrush::getEquivalentXPSBrush ( IEDLClassFactory * pFactory,
const FRect & enclosedBounds )
pure virtual

Gets an equivalent image or visual brush that can be used to express this masked brush in XPS compatible form. This does not guarantee that the sub brush can be represented in XPS; these ought to be processed first. To do this, the bounds of the enclosing object in internal space must be provided (that is, the coordinate space effective inside that object).

Parameters
pFactoryA pointer to an EDL class factory
enclosedBoundsThe bounds in internal object space of the object that has this brush.
Returns
IDOMBrushPtr The XPS compatible form of this brush. This brush will be cached, so do not edit; make a clone if the returned brush needs to be changed.

◆ getIsSoftMask()

virtual bool IDOMMaskedBrush::getIsSoftMask ( IEDLClassFactory * pFactory)
pure virtual

Is the mask a soft mask? That is, is the mask not a single bit image? An outright error will result in an exception of type IEDLError.

Parameters
pFactoryA pointer to an EDL class factory
Returns
bool True if the mask is soft.

◆ getSimpleImageBrush()

virtual IDOMImageBrushPtr IDOMMaskedBrush::getSimpleImageBrush ( IEDLClassFactory * pFactory)
pure virtual

Attempts to create a single IDOMImageBrush that representes the masked result. This can be achieved if the brush masked by the image is a solid color brush, or if the brush masked by the image is an image with the same dimensions. Returns NULL if such a brush isn't possible, and throws an IEDLError exception on outright failures.

Parameters
pFactorypFactory A pointer to an EDL class factory
Returns
IDOMImageBrushPtr The image brush. This brush will be cached, so do not edit; make a clone if the returned brush needs to be changed.

◆ setBrush()

virtual void IDOMMaskedBrush::setBrush ( const IDOMBrushPtr & brush)
pure virtual

Sets brush.

Parameters
brushSmart pointer to the brush resource to be painted through the image.

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