hdi::core::CustomArt Class Reference

Allows for custom art "group", user-editable art, and user-viewable "result" art manipulation. More...

#include <hdicoreCustomArt.h>

Public Member Functions
	~CustomArt ()
	Destructs a CustomArt object.
std::unique_ptr< Art >	editableArt () const
	Gets the art underlying the CustomArt that the user can edit in Illustrator.
std::unique_ptr< Art >	viewableArt () const
	Gets the art underlying the CustomArt that the user can see in Illustrator.
void	markDirty ()
	Marks the CustomArt as dirty, so that Illustrator will fire the CustomArtUpdateViewableArtMessageType shortly.
void	markClean ()
	Marks the CustomArt as clean, so that Illustrator will not fire the CustomArtUpdateViewableArtMessageType even if the user-editable art has been changed.
void	silenceNextUpdate ()
	Even if the user-editable art will be changed (or has been changed), this will prevent the CustomArtUpdateViewableArtMessageType message from firing until the next time Illustrator messages your plugin (and you again change the user-editable art)
bool	canBeClipMask () const
	Gets whether your CustomArt is allowed to be a clipping mask.
void	setCanBeClipMask (const bool canBe_)
	Sets whether your CustomArt is allowed to be a clipping mask.

Friends
class	Art

Detailed Description

Allows for custom art "group", user-editable art, and user-viewable "result" art manipulation.

Constructor & Destructor Documentation

~CustomArt()

hdi::core::CustomArt::~CustomArt

(

)

Destructs a CustomArt object.

Author

GW

Date

07/2017

Member Function Documentation

canBeClipMask()

bool hdi::core::CustomArt::canBeClipMask

(

)

const

Gets whether your CustomArt is allowed to be a clipping mask.

Author

GW

Date

07/2017

Returns

true if clipping via your CustomArt is allowed

editableArt()

std::unique_ptr< Art > hdi::core::CustomArt::editableArt

(

)

const

Gets the art underlying the CustomArt that the user can edit in Illustrator.

Author

GW

Date

07/2017

Returns

A pointer to the user-editable art, or NULL for error

Note

The editable art does not show visibly in the Illustrator document except for when the user has selected the CustomArt or has moused-over the CustomArt (then its path and segment annotations will show).

markClean()

void hdi::core::CustomArt::markClean

(

)

Marks the CustomArt as clean, so that Illustrator will not fire the CustomArtUpdateViewableArtMessageType even if the user-editable art has been changed.

Author

GW

Date

07/2017

markDirty()

void hdi::core::CustomArt::markDirty

(

)

Marks the CustomArt as dirty, so that Illustrator will fire the CustomArtUpdateViewableArtMessageType shortly.

Author

GW

Date

07/2017

Note

The correct time to update your user-viewable art is in response to CustomArtUpdateViewableArtMessageType.

setCanBeClipMask()

void hdi::core::CustomArt::setCanBeClipMask

(

const bool

canBe_

)

Sets whether your CustomArt is allowed to be a clipping mask.

Author

GW

Date

07/2017

Parameters

canBe_

true if clipping via your CustomArt is allowed

silenceNextUpdate()

void hdi::core::CustomArt::silenceNextUpdate

(

)

Even if the user-editable art will be changed (or has been changed), this will prevent the CustomArtUpdateViewableArtMessageType message from firing until the next time Illustrator messages your plugin (and you again change the user-editable art)

Author

GW

Date

07/2017

viewableArt()

std::unique_ptr< Art > hdi::core::CustomArt::viewableArt

(

)

const

Gets the art underlying the CustomArt that the user can see in Illustrator.

Author

GW

Date

07/2017

Returns

A pointer to the user-viewable art, or NULL for error

Note

The viewable art need not be the same as the editable art, and it cannot be selected/ modified in the Illustrator document by the user.