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

Effects are contained by art styles and are used to replace typical fill/stroke drawing. More...

#include <hdicoreArtStyle.h>

Public Member Functions

 Effect ()
 Constructs an empty Effect object. More...
 
 Effect (const Effect &e_)
 Constructs a new Effect object from another existing object. More...
 
virtual ~Effect ()
 Destructs an Effect object. More...
 
Effectoperator= (const Effect &rhs_)
 Overloaded assignment operator to copy data from the given Effect object into the target. More...
 
bool isEmpty () const
 Gets whether the target Effect object is empty (constructed with the default ctor) More...
 
bool visible () const
 Gets the visibility status of an effect, which affects whether it is drawn. More...
 
void setVisible (const bool visible_)
 Sets the visibility status of an effect, which affects whether it is drawn. More...
 
std::auto_ptr< LiveEffectliveEffect () const
 Gets the live effect object for the art style effect. More...
 
void setLiveEffect (const LiveEffect &le_)
 Sets the live effect object for the art style effect. More...
 
std::auto_ptr< LiveEffect::Parametersparameters () const
 Gets the live effect parameters object for the art style effect. More...
 
void setParameters (const LiveEffect::Parameters &p_)
 Sets the live effect parameters object for the art style effect. More...
 

Friends

class ArtStyle
 
class PaintField
 

Detailed Description

Effects are contained by art styles and are used to replace typical fill/stroke drawing.

Note
Pre-effects are live effects that show up before any fills and strokes in the appearance panel.
Post-effects are live effects that show up after all the fills and strokes in the appearance panel.

Constructor & Destructor Documentation

hdi::core::ArtStyle::Effect::Effect ( )

Constructs an empty Effect object.

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

Constructs a new Effect object from another existing object.

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

Destructs an Effect object.

Author
GW
Date
08/2014

Member Function Documentation

bool hdi::core::ArtStyle::Effect::isEmpty ( ) const

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

Author
GW
Date
08/2013
Returns
true if the target Effect object is empty, false otherwise
std::auto_ptr<LiveEffect> hdi::core::ArtStyle::Effect::liveEffect ( ) const

Gets the live effect object for the art style effect.

Author
GW
Date
08/2014
Returns
The live effect object, or NULL for error
Effect& hdi::core::ArtStyle::Effect::operator= ( const Effect rhs_)

Overloaded assignment operator to copy data from the given Effect 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
std::auto_ptr<LiveEffect::Parameters> hdi::core::ArtStyle::Effect::parameters ( ) const

Gets the live effect parameters object for the art style effect.

Author
GW
Date
08/2014
Returns
The live effect parameters object, or NULL for error
void hdi::core::ArtStyle::Effect::setLiveEffect ( const LiveEffect le_)

Sets the live effect object for the art style effect.

Author
GW
Date
08/2014
Parameters
le_The new live effect object
void hdi::core::ArtStyle::Effect::setParameters ( const LiveEffect::Parameters p_)

Sets the live effect parameters object for the art style effect.

Author
GW
Date
08/2014
Parameters
p_The new live effect parameters object
void hdi::core::ArtStyle::Effect::setVisible ( const bool  visible_)

Sets the visibility status of an effect, which affects whether it is drawn.

Author
GW
Date
08/2014
Parameters
visible_true if the effect should be visible
bool hdi::core::ArtStyle::Effect::visible ( ) const

Gets the visibility status of an effect, which affects whether it is drawn.

Author
GW
Date
08/2014
Returns
true if the effect is visible