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

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

Effect() [1/2]

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).

Effect() [2/2]

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

~Effect()

virtual hdi::core::ArtStyle::Effect::~Effect ( )

virtual

Destructs an Effect object.

Author

GW

Date

08/2014

Member Function Documentation

isEmpty()

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

liveEffect()

std::unique_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

operator=()

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

parameters()

std::unique_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

setLiveEffect()

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

setParameters()

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

setVisible()

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

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