Hot Door CORE  0.7.0
Adobe® Illustrator® Plug-in Library
Public Member Functions | Friends | List of all members
hdi::core::MaskArt Class Reference

Allows for mask manipulation, metadata access, etc. More...

#include <hdicoreMaskArt.h>

Public Member Functions

 ~MaskArt ()
 Destructs a MaskArt object. More...
 
bool exists () const
 Gets whether a mask for the related art already exists. More...
 
bool create ()
 Creates a mask for the related art object if one does not already exists. More...
 
bool dispose ()
 Disposes the mask for the related art object, if one exists. More...
 
bool linked () const
 Gets the link state of the target mask. More...
 
void setLinked (const bool link_)
 Sets the link state of the target mask. More...
 
bool enabled () const
 Gets the enabled state of the target mask. More...
 
void setEnabled (const bool enable_)
 Sets the enabled state of the target mask. More...
 
bool inverted () const
 Gets the inversion state of the target mask. More...
 
void setInverted (const bool invert_)
 Sets the inversion state of the target mask. More...
 
bool clipped () const
 Gets the clipping state of the target mask. More...
 
void setClipped (const bool clip_)
 Sets the clipping state of the target mask. More...
 
bool copy (const Art &dest_) const
 Copies the target mask to some destination art. More...
 
std::auto_ptr< ArtmaskArt () const
 Gets the art object that comprises the opacity mask. More...
 

Friends

class Art
 

Detailed Description

Allows for mask manipulation, metadata access, etc.

Constructor & Destructor Documentation

hdi::core::MaskArt::~MaskArt ( )

Destructs a MaskArt object.

Author
GW
Date
08/2014

Member Function Documentation

bool hdi::core::MaskArt::clipped ( ) const

Gets the clipping state of the target mask.

Author
GW
Date
08/2014
Returns
true if the mask is clipped, false otherwise
Note
When a mask is clipped, the opacity value outside the mask art is 0%, thus clipping out everything outside the mask art. When clipping is off, the value outside is 100%, thus revealing everything outside the boundary of the mask art.
bool hdi::core::MaskArt::copy ( const Art dest_) const

Copies the target mask to some destination art.

Author
GW
Date
08/2014
Parameters
dest_Destination art object
Returns
true if the copy was performed successfully, false otherwise
bool hdi::core::MaskArt::create ( )

Creates a mask for the related art object if one does not already exists.

Author
GW
Date
08/2014
Returns
true if the mask was created successfully (or already exists)
bool hdi::core::MaskArt::dispose ( )

Disposes the mask for the related art object, if one exists.

Author
GW
Date
08/2014
Returns
true if the mask was disposed successfully (or never existed)
bool hdi::core::MaskArt::enabled ( ) const

Gets the enabled state of the target mask.

Author
GW
Date
08/2014
Returns
true if the mask is enabled, false otherwise
Note
When a mask is disabled, it is ignored when rendering the associated art object.
bool hdi::core::MaskArt::exists ( ) const

Gets whether a mask for the related art already exists.

Author
GW
Date
08/2014
Returns
true if a mask for the art exists, false otherwise
Note
This method is useful in combination with create() and dispose()
bool hdi::core::MaskArt::inverted ( ) const

Gets the inversion state of the target mask.

Author
GW
Date
08/2014
Returns
true if the mask is inverted, false otherwise
Note
When a mask is inverted, the opacity is inverted before being applied to the associated art.
bool hdi::core::MaskArt::linked ( ) const

Gets the link state of the target mask.

Author
GW
Date
08/2014
Returns
true if the mask is linked, false otherwise
Note
When a mask is linked, certain actions on the associated art object, such as rotation, are automatically applied to the mask as well.
std::auto_ptr<Art> hdi::core::MaskArt::maskArt ( ) const

Gets the art object that comprises the opacity mask.

Author
GW
Date
08/2014
Returns
The art object, or NULL if there is no mask
void hdi::core::MaskArt::setClipped ( const bool  clip_)

Sets the clipping state of the target mask.

Author
GW
Date
08/2014
Parameters
clip_true to enable clipping the mask, false to disable
Note
When a mask is clipped, the opacity value outside the mask art is 0%, thus clipping out everything outside the mask art. When clipping is off, the value outside is 100%, thus revealing everything outside the boundary of the mask art.
void hdi::core::MaskArt::setEnabled ( const bool  enable_)

Sets the enabled state of the target mask.

Author
GW
Date
08/2014
Parameters
enable_true to enable the mask, false to disable
Note
When a mask is disabled, it is ignored when rendering the associated art object.
void hdi::core::MaskArt::setInverted ( const bool  invert_)

Sets the inversion state of the target mask.

Author
GW
Date
08/2014
Parameters
invert_true to invert the mask, false to disable
Note
When a mask is inverted, the opacity is inverted before being applied to the associated art.
void hdi::core::MaskArt::setLinked ( const bool  link_)

Sets the link state of the target mask.

Author
GW
Date
08/2014
Parameters
link_true to turn linking on, false to turn it off
Note
When a mask is linked, certain actions on the associated art object, such as rotation, are automatically applied to the mask as well.