Hot Door CORE 0.8.2
Adobe® Illustrator® Plug-in Library
|
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 &) |
hdi::core::LiveEffect::LiveEffect | ( | ) |
Constructs an empty LiveEffect object.
hdi::core::LiveEffect::LiveEffect | ( | const LiveEffect & | le_ | ) |
Constructs a new LiveEffect object from an existing LiveEffect object (copy constructor)
le_ | Existing LiveEffect object |
hdi::core::LiveEffect::LiveEffect | ( | const AILiveEffectHandle | aiLiveEff_ | ) |
Constructs a new LiveEffect object from an AILiveEffectHandle.
aiLiveEff_ | Raw Illustrator AILiveEffectHandle |
|
virtual |
LiveEffect object destructor.
|
virtual |
Gets the live effect handle around which the target object is wrapped.
|
virtual |
Gets the earliest Illustrator version that an effect supports.
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 |
|
virtual |
Gets the preferred input art types of the target effect.
|
virtual |
Gets whether the target LiveEffect object is empty (constructed with the default ctor)
|
virtual |
Merges the target effect into the existing style of all selected objects.
act_ | The merge method (append, or replace fill and/or stroke) |
|
virtual |
Gets the unique name of the target effect.
|
virtual |
Tests whether a given LiveEffect object is not the same as another.
rhs_ | LiveEffect to compare against (righthand side of inequality operator) |
|
virtual |
Assigns one LiveEffect object to another.
rhs_ | Existing LiveEffect object to copy values from |
|
virtual |
Tests whether a given LiveEffect object is the same as another.
rhs_ | LiveEffect to compare against (righthand side of equality operator) |
|
virtual |
Sets the earliest Illustrator version that an effect supports.
rgbVers_ | The earliest version number that the effect supports for RGB documents |
cmykVers_ | The earliest version number that the effect supports for CMYK documents |
|
virtual |
Gets the style flags of the target effect.
|
virtual |
Gets the UI-visible title of the effect.
|
virtual |
Gets the version info for the target live effect.
major__ | Return-by-reference for the major version |
minor__ | Return-by-reference for the minor version |