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

Describes blending info for an art style or paint field of an art style. More...

#include <hdicoreArtStyle.h>

Public Member Functions

 BlendField ()
 Constructs an empty BlendField object. More...
 
 BlendField (const BlendField &bf_)
 Constructs a new BlendField object from another existing object. More...
 
virtual ~BlendField ()
 Destructs a BlendField object. More...
 
BlendFieldoperator= (const BlendField &rhs_)
 Overloaded assignment operator to copy data from the given BlendField object into the target. More...
 
bool isEmpty () const
 Gets whether the target BlendField object is empty (constructed with the default ctor) More...
 
bool isDefault () const
 Gets whether a blend field is a default blend; that is, normal 100% opacity with non-isolated blending and the knockout attribute set to either off or inherit. More...
 
void setDefault ()
 Sets a blend field to a default blend; that is, normal 100% opacity with non-isolated blending and the knockout attribute set to off. More...
 
bool visible () const
 Gets the visibility status of a blend field, which affects whether it is drawn. More...
 
void setVisible (const bool visible_)
 Sets the visibility status of a blend field, which affects whether it is drawn. This is applied to all the art objects currently targeted in the document. More...
 
BlendMode mode () const
 Retrieves the blending mode of a blend field. More...
 
void setMode (const BlendMode mode_)
 Sets the blending mode of a blend field. More...
 
double opacity () const
 Retrieves the opacity value of a blend field. More...
 
void setOpacity (const double o_)
 Sets the opacity value of a blend field. More...
 
bool isolated () const
 Gets the isolation state of a blend field. More...
 
void setIsolated (const bool iso_)
 Sets the isolation state of a blend field. More...
 
BlendKnockout knockout () const
 Retrieves the knockout setting of a blend field. More...
 
void setKnockout (const BlendKnockout ko_)
 Sets the knockout setting of a blend field. More...
 
bool alphaIsShape () const
 Gets whether opacity and mask define the knockout shape. More...
 
void setAlphaIsShape (const bool alpha_)
 Sets whether opacity and mask define the knockout shape. More...
 

Friends

class ArtStyle
 
class PaintField
 

Detailed Description

Describes blending info for an art style or paint field of an art style.

Constructor & Destructor Documentation

hdi::core::ArtStyle::BlendField::BlendField ( )

Constructs an empty BlendField object.

Author
GW
Date
08/2014
Note
To test if a BlendField object is empty, call isEmpty() on it
Empty BlendField objects do not relate to any actual art style blend field; they are designed to be "receivers" of some other BlendField object via the overloaded assignment operator. Empty BlendField objects are useless until such time (though it is safe to call any of their methods).
hdi::core::ArtStyle::BlendField::BlendField ( const BlendField bf_)

Constructs a new BlendField object from another existing object.

Author
GW
Date
08/2014
Parameters
bf_Existing object to copy
virtual hdi::core::ArtStyle::BlendField::~BlendField ( )
virtual

Destructs a BlendField object.

Author
GW
Date
08/2014

Member Function Documentation

bool hdi::core::ArtStyle::BlendField::alphaIsShape ( ) const

Gets whether opacity and mask define the knockout shape.

Author
GW
Date
08/2014
Returns
true if opacity and mask define the knockout shape
bool hdi::core::ArtStyle::BlendField::isDefault ( ) const

Gets whether a blend field is a default blend; that is, normal 100% opacity with non-isolated blending and the knockout attribute set to either off or inherit.

Author
GW
Date
08/2014
Returns
true if the blend is "default", false otherwise
bool hdi::core::ArtStyle::BlendField::isEmpty ( ) const

Gets whether the target BlendField object is empty (constructed with the default ctor)

Author
GW
Date
08/2013
Returns
true if the target BlendField object is empty, false otherwise
bool hdi::core::ArtStyle::BlendField::isolated ( ) const

Gets the isolation state of a blend field.

Author
GW
Date
08/2014
Returns
true if isolated, false otherwise
BlendKnockout hdi::core::ArtStyle::BlendField::knockout ( ) const

Retrieves the knockout setting of a blend field.

Author
GW
Date
08/2014
Returns
The knockout enum value
BlendMode hdi::core::ArtStyle::BlendField::mode ( ) const

Retrieves the blending mode of a blend field.

Author
GW
Date
08/2014
Returns
The blending mode enum value
double hdi::core::ArtStyle::BlendField::opacity ( ) const

Retrieves the opacity value of a blend field.

Author
GW
Date
08/2014
Returns
The opacity value, in the range [0,1] where 0 is completely transparent and 1 is completely opaque
BlendField& hdi::core::ArtStyle::BlendField::operator= ( const BlendField rhs_)

Overloaded assignment operator to copy data from the given BlendField object into the target.

Author
GW
Date
08/2014
Parameters
rhs_Righthand side of the assignment operator
Returns
The lefthand side of the assignment operator, but with its values updated
void hdi::core::ArtStyle::BlendField::setAlphaIsShape ( const bool  alpha_)

Sets whether opacity and mask define the knockout shape.

Author
GW
Date
08/2014
Parameters
alpha_true if opacity and mask define the knockout shape
void hdi::core::ArtStyle::BlendField::setDefault ( )

Sets a blend field to a default blend; that is, normal 100% opacity with non-isolated blending and the knockout attribute set to off.

Author
GW
Date
08/2014
void hdi::core::ArtStyle::BlendField::setIsolated ( const bool  iso_)

Sets the isolation state of a blend field.

Author
GW
Date
08/2014
Parameters
iso_true to isolate, false otherwise
void hdi::core::ArtStyle::BlendField::setKnockout ( const BlendKnockout  ko_)

Sets the knockout setting of a blend field.

Author
GW
Date
08/2014
Parameters
ko_New knockout enum value
void hdi::core::ArtStyle::BlendField::setMode ( const BlendMode  mode_)

Sets the blending mode of a blend field.

Author
GW
Date
08/2014
Parameters
mode_New blending mode enum value
void hdi::core::ArtStyle::BlendField::setOpacity ( const double  o_)

Sets the opacity value of a blend field.

Author
GW
Date
08/2014
Parameters
o_New opacity value, in the range [0,1]
void hdi::core::ArtStyle::BlendField::setVisible ( const bool  visible_)

Sets the visibility status of a blend field, which affects whether it is drawn. This is applied to all the art objects currently targeted in the document.

Author
GW
Date
08/2014
Parameters
visible_true to show, false to hide the blend field
bool hdi::core::ArtStyle::BlendField::visible ( ) const

Gets the visibility status of a blend field, which affects whether it is drawn.

Author
GW
Date
08/2014
Returns
true if visible, false otherwise