AIMaskSuite Struct Reference
[API Suite List]

This suite provides functions to access the opacity mask that can be associated with an art object. More...

#include <AIMask.h>

Public Attributes
AIAPI ai::int32(*	AddRef )(AIMaskRef mask)
	Increments the reference count for a mask.
AIAPI ai::int32(*	Release )(AIMaskRef mask)
	Decrements the reference count for a mask, and, when the count reaches 0, frees the associated memory.
AIAPI AIErr(*	GetMask )(AIArtHandle object, AIMaskRef *mask)
	Retrieves the mask associated with an art object, if any.
AIAPI AIErr(*	CreateMask )(AIArtHandle object)
	Creates a mask for an art object if it does not already have one.
AIAPI AIErr(*	DeleteMask )(AIArtHandle object)
	Deletes the mask association between an art object and its mask, and decrements the reference count of the mask.
AIAPI AIBoolean(*	GetLinked )(AIMaskRef mask)
	Reports the link state of a mask.
AIAPI AIErr(*	SetLinked )(AIMaskRef mask, AIBoolean linked)
	Sets the link state of a mask.
AIAPI AIBoolean(*	GetDisabled )(AIMaskRef mask)
	Reports the disabled state of a mask.
AIAPI AIErr(*	SetDisabled )(AIMaskRef mask, AIBoolean disabled)
	Sets the disabled state of a mask.
AIAPI AIBoolean(*	GetInverted )(AIMaskRef mask)
	Reports the inverted state of a mask.
AIAPI AIErr(*	SetInverted )(AIMaskRef mask, AIBoolean inverted)
	Sets the inverted state of a mask.
AIAPI AIErr(*	Copy )(const AIArtHandle source, AIArtHandle destination)
	Copies a mask and its link status from one art object to another.
AIAPI AIArtHandle(*	GetArt )(AIMaskRef mask)
	Retrieves the art object that comprises an opacity mask, if any.
AIAPI AIBoolean(*	IsEditingArt )(AIMaskRef mask)
	Reports whether the art object that comprises an opacity mask is currently being edited.
AIAPI AIErr(*	SetEditingArt )(AIMaskRef mask, AIBoolean isedit)
	Turns editing on or off for the art object associated with a mask.
AIAPI AIErr(*	GetMaskedArt )(AIArtHandle mask, AIArtHandle *masked)
	Retrieves the masked art object associated with a group art object that is the mask art for another art object.
AIAPI AIBoolean(*	GetClipping )(AIMaskRef mask)
	Reports the clipping state of a mask.
AIAPI AIErr(*	SetClipping )(AIMaskRef mask, AIBoolean clipping)
	Sets the clipping state of a mask.

Detailed Description

This suite provides functions to access the opacity mask that can be associated with an art object.

Opacity values from the mask are combined with the object's own opacity when compositing it.

Mask objects are reference counted.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIMaskSuite and kAIMaskVersion.

Member Data Documentation

AIAPI ai::int32(* AIMaskSuite::AddRef)(AIMaskRef mask)

Increments the reference count for a mask.

(Note that this function returns an integer value, not an error code.)

Parameters:

mask

The mask object.

Returns:: The new reference count for the mask.

AIAPI AIErr(* AIMaskSuite::Copy)(const AIArtHandle source, AIArtHandle destination)

Copies a mask and its link status from one art object to another.

Parameters:

	source	The source art object.
	destination	The destination art object.

AIAPI AIErr(* AIMaskSuite::CreateMask)(AIArtHandle object)

Creates a mask for an art object if it does not already have one.

The art of the newly created mask is an empty group object. Retrieve the new mask with GetMask().

Parameters:

object

The art object.

AIAPI AIErr(* AIMaskSuite::DeleteMask)(AIArtHandle object)

Deletes the mask association between an art object and its mask, and decrements the reference count of the mask.

If the reference count is then 0, also deletes the mask object.

Parameters:

object

The art object.

AIAPI AIArtHandle(* AIMaskSuite::GetArt)(AIMaskRef mask)

Retrieves the art object that comprises an opacity mask, if any.

(Note that this function returns an object value, not an error code.)

Parameters:

mask

The mask object.

Returns:: The art object, or NULL if there is no mask art.

AIAPI AIBoolean(* AIMaskSuite::GetClipping)(AIMaskRef mask)

Reports the clipping state of a mask.

(Note that this function returns a boolean value, not an error code.)

Parameters:

mask

The mask object.

Returns:: True if the art associated with the mask is clipped.

AIAPI AIBoolean(* AIMaskSuite::GetDisabled)(AIMaskRef mask)

Reports the disabled state of a mask.

When a mask is disabled, it is ignored when rendering the associated art object. (Note that this function returns a boolean value, not an error code.)

Parameters:

mask

The mask object.

Returns:: True if the mask is disabled.

AIAPI AIBoolean(* AIMaskSuite::GetInverted)(AIMaskRef mask)

Reports the inverted state of a mask.

When a mask is inverted, the opacity is inverted before being applied to the associated art. (Note that this function returns a boolean value, not an error code.)

Parameters:

mask

The mask object.

Returns:: True if the mask is inverted.

AIAPI AIBoolean(* AIMaskSuite::GetLinked)(AIMaskRef mask)

Reports the link state of a mask.

When a mask is linked, certain actions on the associated art object, such as rotation, are automatically applied to the mask as well. (Note that this function returns a boolean value, not an error code.)

Parameters:

mask

The mask object.

Returns:: True if the mask is linked.

AIAPI AIErr(* AIMaskSuite::GetMask)(AIArtHandle object, AIMaskRef *mask)

Retrieves the mask associated with an art object, if any.

Parameters:

	object	The art object.
	mask	[out] A buffer in which to return the mask object.

AIAPI AIErr(* AIMaskSuite::GetMaskedArt)(AIArtHandle mask, AIArtHandle *masked)

Retrieves the masked art object associated with a group art object that is the mask art for another art object.

Parameters:

	mask	The group art object.
`[out]`	A	buffer in which to return the masked art object, or `NULL` if the input art object is not used as a mask.

AIAPI AIBoolean(* AIMaskSuite::IsEditingArt)(AIMaskRef mask)

Reports whether the art object that comprises an opacity mask is currently being edited.

(Note that this function returns a boolean value, not an error code.)

Parameters:

mask

The mask object.

Returns:: True if the mask art is being edited.

AIAPI ai::int32(* AIMaskSuite::Release)(AIMaskRef mask)

Decrements the reference count for a mask, and, when the count reaches 0, frees the associated memory.

(Note that this function returns an integer value, not an error code.)

Parameters:

mask

The mask object.

Returns:: The new reference count for the mask.

AIAPI AIErr(* AIMaskSuite::SetClipping)(AIMaskRef mask, AIBoolean clipping)

Sets the clipping state of a mask.

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

Parameters:

	mask	The mask object.
	clipping	True to turn clipping on, false to turn it off.

AIAPI AIErr(* AIMaskSuite::SetDisabled)(AIMaskRef mask, AIBoolean disabled)

Sets the disabled state of a mask.

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

Parameters:

	mask	The mask object.
	disabled	True to disable the mask, false to enable it.

AIAPI AIErr(* AIMaskSuite::SetEditingArt)(AIMaskRef mask, AIBoolean isedit)

Turns editing on or off for the art object associated with a mask.

Editing mask art causes a new layer to be created at the top of the current layer list containing the mask art. When editing is terminated the layer is deleted.

Parameters:

	mask	The mask object.
	isedit	True to turn editing on, false to turn it off.

See also:: AILayerListSuite

AIAPI AIErr(* AIMaskSuite::SetInverted)(AIMaskRef mask, AIBoolean inverted)

Sets the inverted state of a mask.

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

Parameters:

	mask	The mask object.
	inverted	True to invert the mask, false to turn inversion off.

AIAPI AIErr(* AIMaskSuite::SetLinked)(AIMaskRef mask, AIBoolean linked)

Sets the link state of a mask.

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

Parameters:

	mask	The mask object.
	linked	True to turn linking on, false to turn it off.

The documentation for this struct was generated from the following file:

AIMask.h

AIMaskSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AIMaskSuite Struct Reference
[API Suite List]