Describes blending info for an art style or paint field of an art style. More...

#include <hdicoreArtStyle.h>

Public Member Functions
	BlendField ()
	Constructs an empty BlendField object.

	BlendField (const BlendField &bf_)
	Constructs a new BlendField object from another existing object.

virtual	~BlendField ()
	Destructs a BlendField object.

BlendField &	operator= (const BlendField &rhs_)
	Overloaded assignment operator to copy data from the given BlendField object into the target.

bool	isEmpty () const
	Gets whether the target BlendField object is empty (constructed with the default ctor)

bool	isDefault () const
	Gets whether a blend field is a default blend; that is, normal 100% opacity with non-isolated blending and the knockout attribute set to either off or inherit.

void	setDefault ()
	Sets a blend field to a default blend; that is, normal 100% opacity with non-isolated blending and the knockout attribute set to off.

bool	visible () const
	Gets the visibility status of a blend field, which affects whether it is drawn.

void	setVisible (const bool visible_)
	Sets the visibility status of a blend field, which affects whether it is drawn. This is applied to all the art objects currently targeted in the document.

BlendMode	mode () const
	Retrieves the blending mode of a blend field.

void	setMode (const BlendMode mode_)
	Sets the blending mode of a blend field.

double	opacity () const
	Retrieves the opacity value of a blend field.

void	setOpacity (const double o_)
	Sets the opacity value of a blend field.

bool	isolated () const
	Gets the isolation state of a blend field.

void	setIsolated (const bool iso_)
	Sets the isolation state of a blend field.

BlendKnockout	knockout () const
	Retrieves the knockout setting of a blend field.

void	setKnockout (const BlendKnockout ko_)
	Sets the knockout setting of a blend field.

bool	alphaIsShape () const
	Gets whether opacity and mask define the knockout shape.

void	setAlphaIsShape (const bool alpha_)
	Sets whether opacity and mask define the knockout shape.

Friends
class	ArtStyle

class	PaintField

Detailed Description

Describes blending info for an art style or paint field of an art style.

Constructor & Destructor Documentation

◆ BlendField() [1/2]

hdi::core::ArtStyle::BlendField::BlendField ( )

Constructs an empty BlendField object.

Author: GW

Date: 08/2014

Note: To test if a BlendField object is empty, call isEmpty() on it; Empty BlendField objects do not relate to any actual art style blend field; they are designed to be "receivers" of some other BlendField object via the overloaded assignment operator. Empty BlendField objects are useless until such time (though it is safe to call any of their methods).

◆ BlendField() [2/2]

hdi::core::ArtStyle::BlendField::BlendField ( const BlendField & bf_ )

Constructs a new BlendField object from another existing object.

Author: GW

Date: 08/2014

Parameters

bf_	Existing object to copy

◆ ~BlendField()

virtual hdi::core::ArtStyle::BlendField::~BlendField ( )

virtual

Destructs a BlendField object.

Author: GW

Date: 08/2014

Member Function Documentation

◆ alphaIsShape()

bool hdi::core::ArtStyle::BlendField::alphaIsShape ( ) const

Gets whether opacity and mask define the knockout shape.

Author: GW

Date: 08/2014

Returns: true if opacity and mask define the knockout shape

◆ isDefault()

bool hdi::core::ArtStyle::BlendField::isDefault ( ) const

Gets whether a blend field is a default blend; that is, normal 100% opacity with non-isolated blending and the knockout attribute set to either off or inherit.

Author: GW

Date: 08/2014

Returns: true if the blend is "default", false otherwise

◆ isEmpty()

bool hdi::core::ArtStyle::BlendField::isEmpty ( ) const

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

Author: GW

Date: 08/2013

Returns: true if the target BlendField object is empty, false otherwise

◆ isolated()

bool hdi::core::ArtStyle::BlendField::isolated ( ) const

Gets the isolation state of a blend field.

Author: GW

Date: 08/2014

Returns: true if isolated, false otherwise

◆ knockout()

BlendKnockout hdi::core::ArtStyle::BlendField::knockout ( ) const

Retrieves the knockout setting of a blend field.

Author: GW

Date: 08/2014

Returns: The knockout enum value

◆ mode()

BlendMode hdi::core::ArtStyle::BlendField::mode ( ) const

Retrieves the blending mode of a blend field.

Author: GW

Date: 08/2014

Returns: The blending mode enum value

◆ opacity()

double hdi::core::ArtStyle::BlendField::opacity ( ) const

Retrieves the opacity value of a blend field.

Author: GW

Date: 08/2014

Returns: The opacity value, in the range [0,1] where 0 is completely transparent and 1 is completely opaque

◆ operator=()

BlendField & hdi::core::ArtStyle::BlendField::operator= ( const BlendField & rhs_ )

Overloaded assignment operator to copy data from the given BlendField object into the target.

Author: GW

Date: 08/2014

Parameters

rhs_	Righthand side of the assignment operator

Returns: The lefthand side of the assignment operator, but with its values updated

◆ setAlphaIsShape()

void hdi::core::ArtStyle::BlendField::setAlphaIsShape ( const bool alpha_ )

Sets whether opacity and mask define the knockout shape.

Author: GW

Date: 08/2014

Parameters

alpha_ true if opacity and mask define the knockout shape

◆ setDefault()

void hdi::core::ArtStyle::BlendField::setDefault ( )

Sets a blend field to a default blend; that is, normal 100% opacity with non-isolated blending and the knockout attribute set to off.

Author: GW

Date: 08/2014

◆ setIsolated()

void hdi::core::ArtStyle::BlendField::setIsolated ( const bool iso_ )

Sets the isolation state of a blend field.

Author: GW

Date: 08/2014

Parameters

iso_	true to isolate, false otherwise

◆ setKnockout()

void hdi::core::ArtStyle::BlendField::setKnockout ( const BlendKnockout ko_ )

Sets the knockout setting of a blend field.

Author: GW

Date: 08/2014

Parameters

ko_	New knockout enum value

◆ setMode()

void hdi::core::ArtStyle::BlendField::setMode ( const BlendMode mode_ )

Sets the blending mode of a blend field.

Author: GW

Date: 08/2014

Parameters

mode_ New blending mode enum value

◆ setOpacity()

void hdi::core::ArtStyle::BlendField::setOpacity ( const double o_ )

Sets the opacity value of a blend field.

Author: GW

Date: 08/2014

Parameters

o_	New opacity value, in the range [0,1]

◆ setVisible()

void hdi::core::ArtStyle::BlendField::setVisible ( const bool visible_ )

Sets the visibility status of a blend field, which affects whether it is drawn. This is applied to all the art objects currently targeted in the document.

Author: GW

Date: 08/2014

Parameters

visible_ true to show, false to hide the blend field

◆ visible()

bool hdi::core::ArtStyle::BlendField::visible ( ) const

Gets the visibility status of a blend field, which affects whether it is drawn.

Author: GW

Date: 08/2014

Returns: true if visible, false otherwise

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ BlendField() [1/2]

◆ BlendField() [2/2]

◆ ~BlendField()

Member Function Documentation

◆ alphaIsShape()

◆ isDefault()

◆ isEmpty()

◆ isolated()

◆ knockout()

◆ mode()

◆ opacity()

◆ operator=()

◆ setAlphaIsShape()

◆ setDefault()

◆ setIsolated()

◆ setKnockout()

◆ setMode()

◆ setOpacity()

◆ setVisible()

◆ visible()