hdi::core::MaskArt Class Reference

Allows for mask manipulation, metadata access, etc. More...

#include <hdicoreMaskArt.h>

Public Member Functions
	~MaskArt ()
	Destructs a MaskArt object.
bool	exists () const
	Gets whether a mask for the related art already exists.
bool	create ()
	Creates a mask for the related art object if one does not already exists.
bool	dispose ()
	Disposes the mask for the related art object, if one exists.
bool	linked () const
	Gets the link state of the target mask.
void	setLinked (const bool link_)
	Sets the link state of the target mask.
bool	enabled () const
	Gets the enabled state of the target mask.
void	setEnabled (const bool enable_)
	Sets the enabled state of the target mask.
bool	inverted () const
	Gets the inversion state of the target mask.
void	setInverted (const bool invert_)
	Sets the inversion state of the target mask.
bool	clipped () const
	Gets the clipping state of the target mask.
void	setClipped (const bool clip_)
	Sets the clipping state of the target mask.
bool	copy (const Art &dest_) const
	Copies the target mask to some destination art.
std::unique_ptr< Art >	maskArt () const
	Gets the art object that comprises the opacity mask.

Friends
class	Art

Detailed Description

Allows for mask manipulation, metadata access, etc.

Constructor & Destructor Documentation

~MaskArt()

hdi::core::MaskArt::~MaskArt

(

)

Destructs a MaskArt object.

Author

GW

Date

08/2014

Member Function Documentation

clipped()

bool hdi::core::MaskArt::clipped

(

)

const

Gets the clipping state of the target mask.

Author

GW

Date

08/2014

Returns

true if the mask is clipped, false otherwise

Note

When a mask is clipped, the opacity value outside the mask art is 0%, thus clipping out everything outside the mask art. When clipping is off, the value outside is 100%, thus revealing everything outside the boundary of the mask art.

copy()

bool hdi::core::MaskArt::copy

(

const Art &

dest_

)

const

Copies the target mask to some destination art.

Author

GW

Date

08/2014

Parameters

dest_

Destination art object

Returns

true if the copy was performed successfully, false otherwise

create()

bool hdi::core::MaskArt::create

(

)

Creates a mask for the related art object if one does not already exists.

Author

GW

Date

08/2014

Returns

true if the mask was created successfully (or already exists)

dispose()

bool hdi::core::MaskArt::dispose

(

)

Disposes the mask for the related art object, if one exists.

Author

GW

Date

08/2014

Returns

true if the mask was disposed successfully (or never existed)

enabled()

bool hdi::core::MaskArt::enabled

(

)

const

Gets the enabled state of the target mask.

Author

GW

Date

08/2014

Returns

true if the mask is enabled, false otherwise

Note

When a mask is disabled, it is ignored when rendering the associated art object.

exists()

bool hdi::core::MaskArt::exists

(

)

const

Gets whether a mask for the related art already exists.

Author

GW

Date

08/2014

Returns

true if a mask for the art exists, false otherwise

Note

This method is useful in combination with create() and dispose()

inverted()

bool hdi::core::MaskArt::inverted

(

)

const

Gets the inversion state of the target mask.

Author

GW

Date

08/2014

Returns

true if the mask is inverted, false otherwise

Note

When a mask is inverted, the opacity is inverted before being applied to the associated art.

linked()

bool hdi::core::MaskArt::linked

(

)

const

Gets the link state of the target mask.

Author

GW

Date

08/2014

Returns

true if the mask is linked, false otherwise

Note

When a mask is linked, certain actions on the associated art object, such as rotation, are automatically applied to the mask as well.

maskArt()

std::unique_ptr< Art > hdi::core::MaskArt::maskArt

(

)

const

Gets the art object that comprises the opacity mask.

Author

GW

Date

08/2014

Returns

The art object, or NULL if there is no mask

setClipped()

void hdi::core::MaskArt::setClipped

(

const bool

clip_

)

Sets the clipping state of the target mask.

Author

GW

Date

08/2014

Parameters

clip_

true to enable clipping the mask, false to disable

Note

When a mask is clipped, the opacity value outside the mask art is 0%, thus clipping out everything outside the mask art. When clipping is off, the value outside is 100%, thus revealing everything outside the boundary of the mask art.

setEnabled()

void hdi::core::MaskArt::setEnabled

(

const bool

enable_

)

Sets the enabled state of the target mask.

Author

GW

Date

08/2014

Parameters

enable_

true to enable the mask, false to disable

Note

When a mask is disabled, it is ignored when rendering the associated art object.

setInverted()

void hdi::core::MaskArt::setInverted

(

const bool

invert_

)

Sets the inversion state of the target mask.

Author

GW

Date

08/2014

Parameters

invert_

true to invert the mask, false to disable

Note

When a mask is inverted, the opacity is inverted before being applied to the associated art.

setLinked()

void hdi::core::MaskArt::setLinked

(

const bool

link_

)

Sets the link state of the target mask.

Author

GW

Date

08/2014

Parameters

link_

true to turn linking on, false to turn it off

Note

When a mask is linked, certain actions on the associated art object, such as rotation, are automatically applied to the mask as well.