AIBlendStyleSuite Struct Reference
[API Suite List]

This suite provides function for working with blend styles. More...

#include <AIMask.h>

Public Attributes
AIAPI AIBlendingMode(*	GetBlendingMode )(AIArtHandle art)
	Retrieves the current blending mode of an art object, which applies to the object as a whole.
AIAPI AIErr(*	SetBlendingMode )(AIArtHandle art, AIBlendingMode mode)
	Sets the blending mode of an art object, which applies to the object as a whole.
AIAPI AIReal(*	GetOpacity )(AIArtHandle art)
	Retrieves the current opacity value applied by the style to an art object.
AIAPI AIErr(*	SetOpacity )(AIArtHandle art, AIReal opacity)
	Sets the opacity value applied by the style to an art object.
AIAPI AIBoolean(*	GetIsolated )(AIArtHandle art)
	Reports whether any blending modes used in the rendering of the object contents are isolated from what has already been drawn.
AIAPI AIErr(*	SetIsolated )(AIArtHandle art, AIBoolean isolated)
	Sets whether any blending modes used in the rendering of the object contents are isolated from what has already been drawn.
AIAPI AIKnockout(*	GetKnockout )(AIArtHandle art)
	Retrieves the current knockout state of an art object.
AIAPI AIKnockout(*	GetInheritedKnockout )(AIArtHandle art)
	Retrieves the inherited knockout state (on or off) of an art object.
AIAPI AIErr(*	SetKnockout )(AIArtHandle art, AIKnockout knockout)
	Sets the knockout state of an art object.
AIAPI AIBoolean(*	GetAlphaIsShape )(AIArtHandle art)
	Reports whether opacity and mask define the knockout shape for an art object.
AIAPI AIErr(*	SetAlphaIsShape )(AIArtHandle art, AIBoolean alphaIsShape)
	Sets whether opacity and mask define the knockout shape for an art object.
AIAPI AIErr(*	Copy )(const AIArtHandle source, AIArtHandle destination)
	Copies the compositing attributes that are applied globally by the style of one art object to another art object.
AIAPI AIErr(*	GetArtAttrs )(AIArtHandle art, AIDictionaryRef attrs)
	Retrieves the dictionary that contains compositing attributes that are applied globally by the style of an art object.
AIAPI AIErr(*	SetArtAttrs )(AIArtHandle art, AIDictionaryRef attrs)
	Sets the compositing attributes applied globally to an art object, using a dictionary.
AIAPI AIErr(*	GetStyleAttrs )(AIArtStyleHandle style, AIDictionaryRef attrs)
	Retrieves the dictionary that contains globally-applied compositing attributes from an art style.
AIAPI AIErr(*	SetStyleAttrs )(AIArtStyleHandle style, AIDictionaryRef attrs, AIArtStyleHandle *newStyle)
	Modifies the compositing attributes of an art style that are applied globally to an art object, using a dictionary, and creates a new style with the modifications.
AIAPI AIErr(*	GetCurrentTransparency )(AIDictionaryRef styleAttrs, AIDictionaryRef fillAttrs, AIDictionaryRef strokeAttrs)
	Retrieves the common compositing attributes for the current selection in the current document.
AIAPI AIErr(*	SetCurrentTransparency )(AIDictionaryRef styleAttrs, AIDictionaryRef fillAttrs, AIDictionaryRef strokeAttrs)
	Sets compositing attributes for the current selection in the current document.The dictionaries can specify a subset of keys in order to modify a subset of the compositing attributes.
AIAPI AIErr(*	GetFocalFillAttrs )(AIArtStyleHandle artStyle, AIDictionaryRef attrs)
	Retrieves dictionary containing the compositing attributes for the focal fill of an art style.
AIAPI AIErr(*	GetFocalStrokeAttrs )(AIArtStyleHandle artStyle, AIDictionaryRef attrs)
	Retrieves dictionary containing the compositing attributes for the focal stroke of an art style.
AIAPI AIErr(*	SetFocalFillAttrs )(AIArtStyleHandle artStyle, AIDictionaryRef attrs, AIArtStyleHandle *newStyle)
	Modifies the compositing attributes for the focal fill of an art style using a dictionary, and creates a new style with the modifications.
AIAPI AIErr(*	SetFocalStrokeAttrs )(AIArtStyleHandle artStyle, AIDictionaryRef attrs, AIArtStyleHandle *newStyle)
	Modifies the compositing attributes for the focal stroke of an art style using a dictionary, and creates a new style with the modifications.
AIAPI AIBoolean(*	ContainsNonIsolatedBlending )(AIArtHandle object)
	Reports whether an art object contains any artwork with non-normal blending that is not isolated at the level of the object.
AIAPI AIBoolean(*	GetDocumentIsolated )(void)
	Reports the isolation state of the page group, which contains all the layers in the current document.
AIAPI AIErr(*	SetDocumentIsolated )(AIBoolean isolated)
	Sets the isolation state of the page group, which contains all the layers in the current document.
AIAPI AIBoolean(*	GetDocumentKnockout )(void)
	Reports the knockout state of the page group, which contains all the layers in the current document.
AIAPI AIErr(*	SetDocumentKnockout )(AIBoolean knockout)
	Sets the knockout state of the page group, which contains all the layers in the current document.

Detailed Description

This suite provides function for working with blend styles.

When an art object overlaps other art, it is composited with what was drawn before it, using a blend style that is a part of the object's art style. Fills and strokes can have their own compositing attributes.

See the PDF language specification for details of the transparency modes used by Illustrator.

See also:: AIMaskSuite

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIBlendStyleSuite and kAIBlendStyleVersion.

Member Data Documentation

AIAPI AIBoolean(* AIBlendStyleSuite::ContainsNonIsolatedBlending)(AIArtHandle object)

Reports whether an art object contains any artwork with non-normal blending that is not isolated at the level of the object.

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

Parameters:

art

The art object.

Returns:: True if the object does contain artwork with non-isolated blending.

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

Copies the compositing attributes that are applied globally by the style of one art object to another art object.

Parameters:

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

AIAPI AIBoolean(* AIBlendStyleSuite::GetAlphaIsShape)(AIArtHandle art)

Reports whether opacity and mask define the knockout shape for an art object.

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

Parameters:

art

The art object.

Returns:: True if opacity and mask define the knockout shape.

AIAPI AIErr(* AIBlendStyleSuite::GetArtAttrs)(AIArtHandle art, AIDictionaryRef attrs)

Retrieves the dictionary that contains compositing attributes that are applied globally by the style of an art object.

This convenience function has the same effect as retrieving an art object�s art style and getting attributes individually using AIBlendStyleSuite::GetStyleAttrs().

The keys for the compositing attributes are:

		#kAIBlendModeKey
		#kAIBlendOpacityKey
		#kAIBlendIsolatedKey
		#kAIBlendKnockoutKey
		#kAIBlendAlphaIsShapeKey

Parameters:

	art	The art object.
	attrs	[in, out] The dictionary in which to return the attributes.

See also:: AIDictionarySuite

AIAPI AIBlendingMode(* AIBlendStyleSuite::GetBlendingMode)(AIArtHandle art)

Retrieves the current blending mode of an art object, which applies to the object as a whole.

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

Parameters:

art

The art object.

Returns:: The mode constant, one of the AIBlendingModeValues.

AIAPI AIErr(* AIBlendStyleSuite::GetCurrentTransparency)(AIDictionaryRef styleAttrs, AIDictionaryRef fillAttrs, AIDictionaryRef strokeAttrs)

Retrieves the common compositing attributes for the current selection in the current document.

Retrieves only the common attributes; for example, if two objects are selected with different opacities, the opacity entry is not present in the returned dictionary.

Parameters:

	styleAttrs	[in, out] The dictionary in which to return the common attributes applied to objects as a whole. Can be `NULL` if not needed.
	fillAttrs	[in, out] The dictionary in which to return the common attributes applied to the focal fills. Can be `NULL` if not needed.
	strokeAttrs	[in, out] The dictionary in which to return the common attributes applied to the focal strokes. Can be `NULL` if not needed.

See also:: GetArtAttrs() for keys, AIDictionarySuite

AIAPI AIBoolean(* AIBlendStyleSuite::GetDocumentIsolated)(void)

Reports the isolation state of the page group, which contains all the layers in the current document.

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

Returns:: True if the contents of the page is to be drawn in an isolated transparency group.

AIAPI AIBoolean(* AIBlendStyleSuite::GetDocumentKnockout)(void)

Reports the knockout state of the page group, which contains all the layers in the current document.

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

Returns:: True if knockout is on for the page group, false if it is off.

AIAPI AIErr(* AIBlendStyleSuite::GetFocalFillAttrs)(AIArtStyleHandle artStyle, AIDictionaryRef attrs)

Retrieves dictionary containing the compositing attributes for the focal fill of an art style.

Parameters:

	artStyle	The art style object.
	attrs	[in, out] The dictionary in which to return the attributes.

See also:: GetArtAttrs() for keys, AIDictionarySuite

AIAPI AIErr(* AIBlendStyleSuite::GetFocalStrokeAttrs)(AIArtStyleHandle artStyle, AIDictionaryRef attrs)

Retrieves dictionary containing the compositing attributes for the focal stroke of an art style.

Parameters:

	artStyle	The art style object.
	attrs	[in, out] The dictionary in which to return the attributes.

See also:: GetArtAttrs() for keys, AIDictionarySuite

AIAPI AIKnockout(* AIBlendStyleSuite::GetInheritedKnockout)(AIArtHandle art)

Retrieves the inherited knockout state (on or off) of an art object.

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

Parameters:

art

The art object.

Returns:: The knockout state constant, kAIKnockoutOff or kAIKnockoutOn.

AIAPI AIBoolean(* AIBlendStyleSuite::GetIsolated)(AIArtHandle art)

Reports whether any blending modes used in the rendering of the object contents are isolated from what has already been drawn.

This does not affect the blending mode used for compositing the entire object into its backdrop. (Note that this function returns a boolean value, not an error code.)

Parameters:

art

The art object.

Returns:: True if isolation is on.

AIAPI AIKnockout(* AIBlendStyleSuite::GetKnockout)(AIArtHandle art)

Retrieves the current knockout state of an art object.

If the state is kAIKnockoutInherit, the on/off state is inherited from the object�s parent, and you can use GetInheritedKnockout() to retrieve it. (Note that this function returns a constant value, not an error code.)

Parameters:

art

The art object.

Returns:: The knockout state constant, one of the AIKnockout values.

AIAPI AIReal(* AIBlendStyleSuite::GetOpacity)(AIArtHandle art)

Retrieves the current opacity value applied by the style to an art object.

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

Parameters:

art

The art object.

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

AIAPI AIErr(* AIBlendStyleSuite::GetStyleAttrs)(AIArtStyleHandle style, AIDictionaryRef attrs)

Retrieves the dictionary that contains globally-applied compositing attributes from an art style.

Parameters:

	style	The art style object.
	attrs	[in, out] The dictionary in which to return the attributes.

See also:: GetArtAttrs() for keys, AIDictionarySuite

AIAPI AIErr(* AIBlendStyleSuite::SetAlphaIsShape)(AIArtHandle art, AIBoolean alphaIsShape)

Sets whether opacity and mask define the knockout shape for an art object.

Parameters:

	art	The art object.
	alphaIsShape	True if opacity and mask define the knockout shape, false if they do not.

AIAPI AIErr(* AIBlendStyleSuite::SetArtAttrs)(AIArtHandle art, AIDictionaryRef attrs)

Sets the compositing attributes applied globally to an art object, using a dictionary.

This convenience function has the same effect as retrieving an art object�s art style and setting attributes individually using AIBlendStyleSuite::SetStyleAttrs().

Parameters:

	art	The art object.
	attrs	The dictionary containing the attributes. You can specify a subset of the keys in order to modify a subset of the compositing attributes.

See also:: GetArtAttrs() for keys.

AIAPI AIErr(* AIBlendStyleSuite::SetBlendingMode)(AIArtHandle art, AIBlendingMode mode)

Sets the blending mode of an art object, which applies to the object as a whole.

Parameters:

	art	The art object.
	mode	The new mode constant, one of the `AIBlendingModeValues`.

AIAPI AIErr(* AIBlendStyleSuite::SetCurrentTransparency)(AIDictionaryRef styleAttrs, AIDictionaryRef fillAttrs, AIDictionaryRef strokeAttrs)

Sets compositing attributes for the current selection in the current document.The dictionaries can specify a subset of keys in order to modify a subset of the compositing attributes.

Parameters:

	styleAttrs	The dictionary containing the attributes applied to objects as a whole. Can be `NULL` if not needed.
	fillAttrs	The dictionary containing attributes applied to the focal fills. Can be `NULL` if not needed.
	strokeAttrs	The dictionary containing attributes applied to the focal strokes. Can be `NULL` if not needed.

See also:: GetArtAttrs() for keys, AIDictionarySuite

AIAPI AIErr(* AIBlendStyleSuite::SetDocumentIsolated)(AIBoolean isolated)

Sets the isolation state of the page group, which contains all the layers in the current document.

Parameters:

isolated

True to turn isolation on, false to turn it off.

AIAPI AIErr(* AIBlendStyleSuite::SetDocumentKnockout)(AIBoolean knockout)

Sets the knockout state of the page group, which contains all the layers in the current document.

Parameters:

knockout

True to turn knockout on, false to turn it off.

AIAPI AIErr(* AIBlendStyleSuite::SetFocalFillAttrs)(AIArtStyleHandle artStyle, AIDictionaryRef attrs, AIArtStyleHandle *newStyle)

Modifies the compositing attributes for the focal fill of an art style using a dictionary, and creates a new style with the modifications.

Parameters:

	artStyle	The source art style object. Not modified.
	attrs	The dictionary containing the attributes.
	newStyle	[out] A buffer in which to return a new style object containing the modifications.

See also:: GetArtAttrs() for keys, AIDictionarySuite

AIAPI AIErr(* AIBlendStyleSuite::SetFocalStrokeAttrs)(AIArtStyleHandle artStyle, AIDictionaryRef attrs, AIArtStyleHandle *newStyle)

Modifies the compositing attributes for the focal stroke of an art style using a dictionary, and creates a new style with the modifications.

Parameters:

	artStyle	The source art style object. Not modified.
	attrs	The dictionary containing the attributes.
	newStyle	[out] A buffer in which to return a new style object containing the modifications.

See also:: GetArtAttrs() for keys, AIDictionarySuite

AIAPI AIErr(* AIBlendStyleSuite::SetIsolated)(AIArtHandle art, AIBoolean isolated)

Sets whether any blending modes used in the rendering of the object contents are isolated from what has already been drawn.

This does not affect the blending mode used for compositing the entire object into its backdrop.

Parameters:

	art	The art object.
	isolated	True to turn isolation on, false to turn it off.

AIAPI AIErr(* AIBlendStyleSuite::SetKnockout)(AIArtHandle art, AIKnockout knockout)

Sets the knockout state of an art object.

If the state is kAIKnockoutInherit, the on/off state is inherited from the object�s parent.

Parameters:

	art	The art object.
	knockout	The new knockout state: on, off, or inherited,

AIAPI AIErr(* AIBlendStyleSuite::SetOpacity)(AIArtHandle art, AIReal opacity)

Sets the opacity value applied by the style to an art object.

Parameters:

	art	The art object.
	opacity	The new opacity value, in the range [0..1] where 0 is completely transparent and 1 is completely opaque.

AIAPI AIErr(* AIBlendStyleSuite::SetStyleAttrs)(AIArtStyleHandle style, AIDictionaryRef attrs, AIArtStyleHandle *newStyle)

Modifies the compositing attributes of an art style that are applied globally to an art object, using a dictionary, and creates a new style with the modifications.

Parameters:

	style	The source art style object. This object is not modified.
	attrs	The dictionary containing the attributes. You can specify a subset of the keys in order to modify a subset of the compositing attributes.
	newStyle	[out] A buffer in which to return a new style object containing the modifications.

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

AIMask.h

AIBlendStyleSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AIBlendStyleSuite Struct Reference
[API Suite List]