Encapsulates live effect functionality from the Illustrator SDK. More...

#include <hdicoreLiveEffect.h>

Classes
class	Parameters
	Describes the parameters of an Illustrator live effect. More...

Public Types
enum	PreferredInputArtType { InputArtTypeDynamic = 0 , InputArtTypeGroup = 1 << 0 , InputArtTypePath = 1 << 1 , InputArtTypeCompoundPath = 1 << 2 , InputArtTypePlaced = 1 << 3 , InputArtTypeRaster = 1 << 4 , InputArtTypeCustom = 1 << 5 , InputArtTypeMesh = 1 << 6 , InputArtTypeText = 1 << 7 , InputArtTypeSymbol = 1 << 8 , InputArtTypeForeign = 1 << 9 , InputArtTypeTextLegacy = 1 << 10 , InputArtTypeAll = ~0L }

enum	StyleFlags { NoStyleFlags = 0 , PreEffectFilter = 1 , PostEffectFilter = 2 , StrokeFilter = 3 , FillFilter = 4 , FilterTypeMask = 0xFFFF , HasScalableParams = 1 << 17 , UsesAutoRasterize = 1 << 18 , CanGenerateSVGFilter = 1 << 19 , HandlesAdjustColorMsg = 1 << 20 , HandlesIsCompatibleMsg = 1 << 21 }
	Describes the style of a live effect.

enum	MergeAction { UnknownMergeAction = 0 , AppendMergeAction = 10 , ReplaceFillMergeAction = 20 , ReplaceStrokeMergeAction = 30 }
	Describes the merge action of a live effect.

typedef std::unique_ptr< Parameters >	ParametersUP

typedef std::shared_ptr< Parameters >	ParametersSP

typedef std::weak_ptr< Parameters >	ParametersWP

Public Member Functions
	LiveEffect ()
	Constructs an empty LiveEffect object.

	LiveEffect (const LiveEffect &le_)
	Constructs a new LiveEffect object from an existing LiveEffect object (copy constructor)

	LiveEffect (const AILiveEffectHandle aiLiveEff_)
	Constructs a new LiveEffect object from an AILiveEffectHandle.

virtual	~LiveEffect ()
	LiveEffect object destructor.

virtual LiveEffect &	operator= (const LiveEffect &rhs_)
	Assigns one LiveEffect object to another.

virtual bool	isEmpty () const
	Gets whether the target LiveEffect object is empty (constructed with the default ctor)

virtual AILiveEffectHandle	aiLiveEffectHandle () const
	Gets the live effect handle around which the target object is wrapped.

virtual bool	operator== (const LiveEffect &rhs_) const
	Tests whether a given LiveEffect object is the same as another.

virtual bool	operator!= (const LiveEffect &rhs_) const
	Tests whether a given LiveEffect object is not the same as another.

virtual std::string	name () const
	Gets the unique name of the target effect.

virtual std::string	title () const
	Gets the UI-visible title of the effect.

virtual bool	version (int32_t &major__, int32_t &minor__) const
	Gets the version info for the target live effect.

virtual PreferredInputArtType	inputArtPreference () const
	Gets the preferred input art types of the target effect.

virtual StyleFlags	styleFlags () const
	Gets the style flags of the target effect.

virtual bool	mergeIntoSelection (const MergeAction act_)
	Merges the target effect into the existing style of all selected objects.

virtual bool	getEarliestAppVersion (int16_t &rgbVers__, int16_t &cmykVers__) const
	Gets the earliest Illustrator version that an effect supports.

virtual void	setEarliestAppVersion (const int16_t rgbVers_, const int16_t cmykVers_)
	Sets the earliest Illustrator version that an effect supports.

Friends
void *	__accessImpl (const LiveEffect &)

Detailed Description

Encapsulates live effect functionality from the Illustrator SDK.

Constructor & Destructor Documentation

◆ LiveEffect() [1/3]

hdi::core::LiveEffect::LiveEffect ( )

Constructs an empty LiveEffect object.

Author: GW

Date: 08/2014

Note: To test if a LiveEffect object is empty, call isEmpty() on it; Empty LiveEffect objects do not relate to any actual Illustrator live effects; they are designed to be "receivers" of some other LiveEffect object via the overloaded assignment operator. Empty LiveEffect objects are useless until such time (though it is safe to call any of their methods)

◆ LiveEffect() [2/3]

hdi::core::LiveEffect::LiveEffect ( const LiveEffect & le_ )

Constructs a new LiveEffect object from an existing LiveEffect object (copy constructor)

Author: GW

Date: 08/2014

Parameters

le_	Existing LiveEffect object

◆ LiveEffect() [3/3]

hdi::core::LiveEffect::LiveEffect ( const AILiveEffectHandle aiLiveEff_ )

Constructs a new LiveEffect object from an AILiveEffectHandle.

Author: GW

Date: 12/2014

Parameters

aiLiveEff_ Raw Illustrator AILiveEffectHandle

◆ ~LiveEffect()

virtual hdi::core::LiveEffect::~LiveEffect ( )

virtual

LiveEffect object destructor.

Author: GW

Date: 08/2014

Member Function Documentation

◆ aiLiveEffectHandle()

virtual AILiveEffectHandle hdi::core::LiveEffect::aiLiveEffectHandle ( ) const

virtual

Gets the live effect handle around which the target object is wrapped.

Author: GW

Date: 08/2014

Returns: AILiveEffectHandle for this object

Note: Generally, you shouldn't need to call this method. Only use it if you know what you're doing. If a specific piece of functionality provided by Illustrator is not handled by this class (or related classes), then it should probably be added to the hdi_core library.

◆ getEarliestAppVersion()

virtual bool hdi::core::LiveEffect::getEarliestAppVersion	(	int16_t &	rgbVers__,
		int16_t &	cmykVers__ ) const

virtual

Gets the earliest Illustrator version that an effect supports.

Author: GW

Date: 08/2014

Parameters

rgbVers__	Return-by-reference for the earliest version number that the effect supports for RGB documents
cmykVers__	Return-by-reference for the earliest version number that the effect supports for CMYK documents

Returns: true if the version numbers could be acquired, false otherwise

Note: The version number directly corresponds to the major version of Illustrator.

◆ inputArtPreference()

virtual PreferredInputArtType hdi::core::LiveEffect::inputArtPreference ( ) const

virtual

Gets the preferred input art types of the target effect.

Author: GW

Date: 08/2014

Returns: The input art preferences, a bitwise OR of PreferredInputArtType values

◆ isEmpty()

virtual bool hdi::core::LiveEffect::isEmpty ( ) const

virtual

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

Author: GW

Date: 08/2014

Returns: true if the target LiveEffect object is empty, false otherwise

◆ mergeIntoSelection()

virtual bool hdi::core::LiveEffect::mergeIntoSelection ( const MergeAction act_ )

virtual

Merges the target effect into the existing style of all selected objects.

Author: GW

Date: 08/2014

Parameters

act_	The merge method (append, or replace fill and/or stroke)

Returns: true if the merge could take place, false otherwise

◆ name()

virtual std::string hdi::core::LiveEffect::name ( ) const

virtual

Gets the unique name of the target effect.

Author: GW

Date: 08/2014

Returns: Unique name given to the effect when it was created, as UTF-8

◆ operator!=()

virtual bool hdi::core::LiveEffect::operator!= ( const LiveEffect & rhs_ ) const

virtual

Tests whether a given LiveEffect object is not the same as another.

Author: GW

Date: 08/2014

Parameters

rhs_	LiveEffect to compare against (righthand side of inequality operator)

Returns: true for the target and rhs_ being different live effects, false otherwise

◆ operator=()

virtual LiveEffect & hdi::core::LiveEffect::operator= ( const LiveEffect & rhs_ )

virtual

Assigns one LiveEffect object to another.

Author: GW

Date: 08/2014

Parameters

rhs_	Existing LiveEffect object to copy values from

Returns: The target LiveEffect object, but with its values updated to match that of the rhs_ argument

◆ operator==()

virtual bool hdi::core::LiveEffect::operator== ( const LiveEffect & rhs_ ) const

virtual

Tests whether a given LiveEffect object is the same as another.

Author: GW

Date: 08/2014

Parameters

rhs_	LiveEffect to compare against (righthand side of equality operator)

Returns: true for the target and rhs_ being the same live effect, false otherwise

◆ setEarliestAppVersion()

virtual void hdi::core::LiveEffect::setEarliestAppVersion	(	const int16_t	rgbVers_,
		const int16_t	cmykVers_ )

virtual

Sets the earliest Illustrator version that an effect supports.

Author: GW

Date: 08/2014

Parameters

rgbVers_	The earliest version number that the effect supports for RGB documents
cmykVers_	The earliest version number that the effect supports for CMYK documents

Note: The version number directly corresponds to the major version of Illustrator, and must be at least 9.

◆ styleFlags()

virtual StyleFlags hdi::core::LiveEffect::styleFlags ( ) const

virtual

Gets the style flags of the target effect.

Author: GW

Date: 08/2014

Returns: The style flags, a bitwise OR of StyleFlags values

◆ title()

virtual std::string hdi::core::LiveEffect::title ( ) const

virtual

Gets the UI-visible title of the effect.

Author: GW

Date: 08/2014

Returns: The effect title, as UTF-8

◆ version()

virtual bool hdi::core::LiveEffect::version	(	int32_t &	major__,
		int32_t &	minor__ ) const

virtual

Gets the version info for the target live effect.

Author: GW

Date: 08/2014

Parameters

major__	Return-by-reference for the major version
minor__	Return-by-reference for the minor version

Returns: true if the version info could be acquired

Classes

Public Types

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ LiveEffect() [1/3]

◆ LiveEffect() [2/3]

◆ LiveEffect() [3/3]

◆ ~LiveEffect()

Member Function Documentation

◆ aiLiveEffectHandle()

◆ getEarliestAppVersion()

◆ inputArtPreference()

◆ isEmpty()

◆ mergeIntoSelection()

◆ name()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ setEarliestAppVersion()

◆ styleFlags()

◆ title()

◆ version()