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

Describes the parameters of an Illustrator live effect. More...

#include <hdicoreLiveEffect.h>

Public Member Functions

 Parameters ()
 Constructs an empty Parameters object. More...
 
 Parameters (const Parameters &p_)
 Constructs a new Parameters object from an existing Parameters object (copy ctor) More...
 
virtual ~Parameters ()
 Parameters object destructor. More...
 
virtual Parametersoperator= (const Parameters &rhs_)
 Assigns one Parameters object to another. More...
 
virtual bool isEmpty () const
 Gets whether the target Parameters object is empty (constructed with the default ctor) More...
 
virtual AILiveEffectParameters aiLiveEffectParams () const
 Gets the live effect param ref around which the target object is wrapped. More...
 
virtual bool operator== (const Parameters &rhs_) const
 Tests whether a given Parameters object is the same as another. More...
 
virtual bool operator!= (const Parameters &rhs_) const
 Tests whether a given Parameters object is not the same as another. More...
 
virtual std::string displayString () const
 Gets the string that is displayed by the panel in reference to the filter name, if it is set. More...
 
virtual std::string extraString () const
 Gets the string that gives extra information for the panel to display for this filter, e.g. as a tool tip. More...
 
virtual bool fillStyle (FillStyle &fs__) const
 Gets the fill style for the target param. More...
 
virtual bool fillStyleMatrix (TransformMatrix &m__) const
 Gets the fill transform for the target param. More...
 
virtual bool xformedFillStyle (FillStyle &fs__) const
 Gets the fill style for the target param, but with the object's style matrix multiplied in for gradient fills. More...
 
virtual bool strokeStyle (StrokeStyle &ss__) const
 Gets the stroke style for the target param. More...
 
virtual bool strokeStyleMatrix (TransformMatrix &m__) const
 Gets the stroke transform for the target param. More...
 
virtual bool xformedStrokeStyle (StrokeStyle &ss__) const
 Gets the stroke style for the target param, but with the object's style matrix multiplied in for gradient stroke. More...
 
virtual bool evenOdd () const
 Gets the even-odd fill rule for the target param. More...
 
virtual double scaleFactor () const
 Gets the scale factor for the target param. More...
 

Friends

void * __accessImpl (const Parameters &)
 
Parameters __accessCtor (AILiveEffectParameters)
 

Detailed Description

Describes the parameters of an Illustrator live effect.

Constructor & Destructor Documentation

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

Constructs an empty Parameters object.

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

Constructs a new Parameters object from an existing Parameters object (copy ctor)

Author
GW
Date
08/2014
Parameters
p_Existing Parameters object
virtual hdi::core::LiveEffect::Parameters::~Parameters ( )
virtual

Parameters object destructor.

Author
GW
Date
08/2014

Member Function Documentation

virtual AILiveEffectParameters hdi::core::LiveEffect::Parameters::aiLiveEffectParams ( ) const
virtual

Gets the live effect param ref around which the target object is wrapped.

Author
GW
Date
08/2014
Returns
AILiveEffectParameters 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.
virtual std::string hdi::core::LiveEffect::Parameters::displayString ( ) const
virtual

Gets the string that is displayed by the panel in reference to the filter name, if it is set.

Author
GW
Date
08/2014
Returns
The display string, as UTF-8
virtual bool hdi::core::LiveEffect::Parameters::evenOdd ( ) const
virtual

Gets the even-odd fill rule for the target param.

Author
GW
Date
08/2014
Returns
true if the even-odd rule is used to determine path insideness
virtual std::string hdi::core::LiveEffect::Parameters::extraString ( ) const
virtual

Gets the string that gives extra information for the panel to display for this filter, e.g. as a tool tip.

Author
GW
Date
08/2014
Returns
The extra string, as UTF-8
virtual bool hdi::core::LiveEffect::Parameters::fillStyle ( FillStyle fs__) const
virtual

Gets the fill style for the target param.

Author
GW
Date
08/2014
Parameters
fs__Return-by-reference for the fill style
Returns
true if the fill style could be acquired, false otherwise
virtual bool hdi::core::LiveEffect::Parameters::fillStyleMatrix ( TransformMatrix m__) const
virtual

Gets the fill transform for the target param.

Author
GW
Date
08/2014
Parameters
m__Return-by-reference for the matrix
Returns
true if the matrix could be acquired, false otherwise
Note
If the object's fill style matrix is not identity, this will be set in the instance info. The matrix will also be factored into the transformed fill style, but it contains information that is not available in the gradient fields, such as whether there is a reflection.
virtual bool hdi::core::LiveEffect::Parameters::isEmpty ( ) const
virtual

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

Author
GW
Date
08/2014
Returns
true if the target Parameters object is empty, false otherwise
virtual bool hdi::core::LiveEffect::Parameters::operator!= ( const Parameters rhs_) const
virtual

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

Author
GW
Date
08/2014
Parameters
rhs_Parameters to compare against (righthand side of inequality operator)
Returns
true for the target and rhs_ being different live effect parameters, false otherwise
virtual Parameters& hdi::core::LiveEffect::Parameters::operator= ( const Parameters rhs_)
virtual

Assigns one Parameters object to another.

Author
GW
Date
08/2014
Parameters
rhs_Existing Parameters object to copy values from
Returns
The target Parameters object, but with its values updated to match that of the rhs_ argument
virtual bool hdi::core::LiveEffect::Parameters::operator== ( const Parameters rhs_) const
virtual

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

Author
GW
Date
08/2014
Parameters
rhs_Parameters to compare against (righthand side of equality operator)
Returns
true for the target and rhs_ being the same live effect parameters, false otherwise
virtual double hdi::core::LiveEffect::Parameters::scaleFactor ( ) const
virtual

Gets the scale factor for the target param.

Author
GW
Date
08/2014
Returns
The scale factor
virtual bool hdi::core::LiveEffect::Parameters::strokeStyle ( StrokeStyle ss__) const
virtual

Gets the stroke style for the target param.

Author
GW
Date
08/2014
Parameters
ss__Return-by-reference for the stroke style
Returns
true if the stroke style could be acquired, false otherwise
virtual bool hdi::core::LiveEffect::Parameters::strokeStyleMatrix ( TransformMatrix m__) const
virtual

Gets the stroke transform for the target param.

Author
GW
Date
08/2014
Parameters
m__Return-by-reference for the matrix
Returns
true if the matrix could be acquired, false otherwise
Note
If the object's stroke style matrix is not identity, this will be set in the instance info. The matrix will also be factored into the transformed stroke style, but it contains information that is not available in the gradient fields, such as whether there is a reflection.
virtual bool hdi::core::LiveEffect::Parameters::xformedFillStyle ( FillStyle fs__) const
virtual

Gets the fill style for the target param, but with the object's style matrix multiplied in for gradient fills.

Author
GW
Date
08/2014
Parameters
fs__Return-by-reference for the fill style
Returns
true if the fill style could be acquired, false otherwise
virtual bool hdi::core::LiveEffect::Parameters::xformedStrokeStyle ( StrokeStyle ss__) const
virtual

Gets the stroke style for the target param, but with the object's style matrix multiplied in for gradient stroke.

Author
GW
Date
08/2014
Parameters
fs__Return-by-reference for the stroke style
Returns
true if the fill style could be acquired, false otherwise