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

Abstract interface for a brush to which a render transform may be applied. More...

#include <idombrush.h>

Inheritance diagram for IDOMTransformableBrush:

Public Member Functions

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.
 

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

Abstract interface for a brush to which a render transform may be applied.

IDOMTransformableBrush and its descendants can store a render transform and are therefore capable of being used meaningfully within a node that itself has a render transform.
A brush that is to be used within such a node has the node's render transform passed in to it, where it is used to modify any existing render transform that the brush may already have, such that using the brush in a transformed node will always provide the expected results.

Member Function Documentation

◆ getRenderTransform()

virtual const FMatrix & IDOMTransformableBrush::getRenderTransform ( ) const
pure virtual

Retrieves the render transform matrix.

Returns
FMatrix The render transform.

◆ setRenderTransform()

virtual void IDOMTransformableBrush::setRenderTransform ( const FMatrix & matrix)
pure virtual

Sets the render transform matrix.

Parameters
matrixRender transform matrix

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