Hot Door CORE 0.8.2
Adobe® Illustrator® Plug-in Library
|
Corresponds to either a fill or a stroke in an art style. Each paint field can also contain live effects and transparency information. More...
#include <hdicoreArtStyle.h>
Public Member Functions | |
PaintField () | |
Constructs an empty PaintField object. | |
PaintField (const PaintField &pf_) | |
Constructs a new PaintField object from another existing object. | |
virtual | ~PaintField () |
Destructs a PaintField object. | |
PaintField & | operator= (const PaintField &rhs_) |
Overloaded assignment operator to copy data from the given PaintField object into the target. | |
bool | isEmpty () const |
Gets whether the target PaintField object is empty (constructed with the default ctor) | |
bool | visible () const |
Gets the visibility status of blend of a paint field (fill/stroke), which affects whether the blend is drawn. | |
void | setVisible (const bool visible_) |
Sets the visibility status of blend of a paint field (fill/stroke), which affects whether the blend is drawn. This is applied to all the art objects currently targeted in the document. | |
bool | isFill () const |
Reports whether a paint field corresponds to a fill. | |
bool | fill (FillStyle &fs__, PaintData &pd__) |
Gets fill information from a paint field. | |
void | setFill (const FillStyle &fs_, const PaintData &pd_) |
Sets fill information for a paint field. | |
bool | isStroke () const |
Reports whether a paint field corresponds to a stroke. | |
bool | stroke (StrokeStyle &ss__, PaintData &pd__) |
Gets stroke information from a paint field. | |
void | setStroke (const StrokeStyle &ss_, const PaintData &pd_) |
Sets stroke information for a paint field. | |
int32_t | colorPosition () const |
Gets the color position of a paint field (the point in effect order at which painting occurs) | |
void | setColorPosition (const int32_t pos_) |
Sets the color position of a paint field (the point in effect order at which painting occurs) | |
bool | evenOdd () const |
Gets the even-odd fill rule for a paint field. | |
void | setEvenOdd (const bool eo_) |
Sets the even-odd fill rule for a paint field. | |
int32_t | effectCount () const |
Gets the number of effects in a paint field. | |
std::unique_ptr< Effect > | effectAtIndex (const int32_t index_) const |
Gets a effect from a paint field by position index. | |
bool | liveEffectInfo (LiveEffect &le__, LiveEffect::Parameters &p__) |
Retrieves live effect and/or parameter objects for effects in a paint field that substitute for the built-in fill or stroke behavior. | |
void | setLiveEffectInfo (const LiveEffect &le_, const LiveEffect::Parameters &p_) |
Sets the live effect and/or parameter references for effects in a paint field that substitute for the built-in fill or stroke behavior. | |
std::unique_ptr< BlendField > | blend () const |
Gets the blend field for the paint field. | |
Friends | |
class | ArtStyle |
Corresponds to either a fill or a stroke in an art style. Each paint field can also contain live effects and transparency information.
hdi::core::ArtStyle::PaintField::PaintField | ( | ) |
Constructs an empty PaintField object.
hdi::core::ArtStyle::PaintField::PaintField | ( | const PaintField & | pf_ | ) |
Constructs a new PaintField object from another existing object.
pf_ | Existing object to copy |
|
virtual |
Destructs a PaintField object.
std::unique_ptr< BlendField > hdi::core::ArtStyle::PaintField::blend | ( | ) | const |
Gets the blend field for the paint field.
int32_t hdi::core::ArtStyle::PaintField::colorPosition | ( | ) | const |
Gets the color position of a paint field (the point in effect order at which painting occurs)
std::unique_ptr< Effect > hdi::core::ArtStyle::PaintField::effectAtIndex | ( | const int32_t | index_ | ) | const |
Gets a effect from a paint field by position index.
index_ | The position index |
int32_t hdi::core::ArtStyle::PaintField::effectCount | ( | ) | const |
Gets the number of effects in a paint field.
bool hdi::core::ArtStyle::PaintField::evenOdd | ( | ) | const |
Gets the even-odd fill rule for a paint field.
Gets fill information from a paint field.
fs__ | Return-by-reference for the fill style |
pd__ | Return-by-reference for the paint data |
bool hdi::core::ArtStyle::PaintField::isEmpty | ( | ) | const |
Gets whether the target PaintField object is empty (constructed with the default ctor)
bool hdi::core::ArtStyle::PaintField::isFill | ( | ) | const |
Reports whether a paint field corresponds to a fill.
bool hdi::core::ArtStyle::PaintField::isStroke | ( | ) | const |
Reports whether a paint field corresponds to a stroke.
bool hdi::core::ArtStyle::PaintField::liveEffectInfo | ( | LiveEffect & | le__, |
LiveEffect::Parameters & | p__ | ||
) |
Retrieves live effect and/or parameter objects for effects in a paint field that substitute for the built-in fill or stroke behavior.
le__ | Return-by-reference for the live effect |
p__ | Return-by-reference for the effect params |
PaintField & hdi::core::ArtStyle::PaintField::operator= | ( | const PaintField & | rhs_ | ) |
Overloaded assignment operator to copy data from the given PaintField object into the target.
rhs_ | Righthand side of the assignment operator |
void hdi::core::ArtStyle::PaintField::setColorPosition | ( | const int32_t | pos_ | ) |
Sets the color position of a paint field (the point in effect order at which painting occurs)
pos_ | The new paint field color position |
void hdi::core::ArtStyle::PaintField::setEvenOdd | ( | const bool | eo_ | ) |
Sets the even-odd fill rule for a paint field.
eo_ | true if the even-odd rule should be used to determine path insideness |
Sets fill information for a paint field.
fs_ | New fill style |
pd_ | New paint data |
void hdi::core::ArtStyle::PaintField::setLiveEffectInfo | ( | const LiveEffect & | le_, |
const LiveEffect::Parameters & | p_ | ||
) |
Sets the live effect and/or parameter references for effects in a paint field that substitute for the built-in fill or stroke behavior.
le_ | The new live effect; pass an empty one to remove the existing live effect |
p_ | The new effect params; pass an empty one to remove the existing effect params |
void hdi::core::ArtStyle::PaintField::setStroke | ( | const StrokeStyle & | ss_, |
const PaintData & | pd_ | ||
) |
Sets stroke information for a paint field.
ss_ | New stroke style |
pd_ | New paint data |
void hdi::core::ArtStyle::PaintField::setVisible | ( | const bool | visible_ | ) |
Sets the visibility status of blend of a paint field (fill/stroke), which affects whether the blend is drawn. This is applied to all the art objects currently targeted in the document.
visible_ | true if the blend field should be visible, false otherwise |
bool hdi::core::ArtStyle::PaintField::stroke | ( | StrokeStyle & | ss__, |
PaintData & | pd__ | ||
) |
Gets stroke information from a paint field.
ss__ | Return-by-reference for the stroke style |
pd__ | Return-by-reference for the paint data |
bool hdi::core::ArtStyle::PaintField::visible | ( | ) | const |
Gets the visibility status of blend of a paint field (fill/stroke), which affects whether the blend is drawn.