AIGroupSuite Struct Reference
[API Suite List]

This suite provides functions for working with clipping and compound paths in art group objects. More...

#include <AIGroup.h>

List of all members.

Public Attributes
AIAPI AIErr(*	GetGroupClipped )(AIArtHandle group, AIBoolean *clipped)
	Reports whether a group is marked as a clipping group; that is, kArtIsClipMask is set for the group.
AIAPI AIErr(*	SetGroupClipped )(AIArtHandle group, AIBoolean clipped)
	Marks or unmarks a group as a clipping group; that is, sets or clears kArtIsClipMask for the group.
AIAPI AIErr(*	GetGroupMaskLock )(AIArtHandle group, AIBoolean *maskLocked)
	Obsolete.
AIAPI AIErr(*	SetGroupMaskLock )(AIArtHandle group, AIBoolean maskLocked)
	Obsolete.
AIAPI AIErr(*	NormalizeCompoundPath )(AIArtHandle compound, AINormalizeCompoundPathAlgorithm algorithm)
	Normalizes the components of a compound path; that is, it sorts the members such that the object that appears to be on the outside is in the back of the paint order, with the points ordered so that the path does not appear reversed in the Attributes palette.

---

Detailed Description

This suite provides functions for working with clipping and compound paths in art group objects.

An art object of type kGroupArt is an ordered collection of art objects.typically created with the Group command. The group as a whole can have a style or transparency blending attributes which affect the rendering of its contents.

In a clip group, one or more of the members is a clipping object (that is, an art object with the kArtIsClipMask flag set, which defines a clip path). The intersection of the clip paths is used to clip the rendering of the other objects (clipped objects) in the group.

An art object of type kCompoundPathArt is a group whose members are other groups and path objects.

See also:

AIArtSuite for additional artwork group functionality, such as traversing a group's children and reordering its contents.

• Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIGroupSuite and kAIGroupVersion.

---

Member Data Documentation

AIAPI AIErr(* AIGroupSuite::GetGroupClipped)(AIArtHandle group, AIBoolean *clipped)

Reports whether a group is marked as a clipping group; that is, kArtIsClipMask is set for the group.

Use AIArtSuite::GetArtUserAttr() to determine which members of the group (if any) are clipping objects.

Parameters:

	group	The art group object.
	clipped	[out] A buffer in which to return true if the group is marked as a clipping group.

AIAPI AIErr(* AIGroupSuite::GetGroupMaskLock)(AIArtHandle group, AIBoolean *maskLocked)

Obsolete.

Always returns true.

AIAPI AIErr(* AIGroupSuite::NormalizeCompoundPath)(AIArtHandle compound, AINormalizeCompoundPathAlgorithm algorithm)

Normalizes the components of a compound path; that is, it sorts the members such that the object that appears to be on the outside is in the back of the paint order, with the points ordered so that the path does not appear reversed in the Attributes palette.

The paths that define "holes" in the figure are stacked in a defined order.

The stacking order of a compound path does not affect how it is filled. Normalizing does not modify the fill area. It does provide these benefits:

• It is easier to directly select the outlines of the holes, which are brought to the front. Otherwise, the outer path gets hit-tested first.
• If a complex stroke such as a brush stroke is applied to a hole, that stroke is in front of the strokes for the outer paths.
• When blending from one path to another, the component paths are matched more intuitively.

This is especially important for Type Outlines, because fonts are typically designed with the holes in the back, causing blends between single outline and multiple outline characters to match the single path of the one-path character to an inner path of the multiple-path character.

Parameters:

	compound	The compound path object.
	algorithm	The normalization algorithm to use.

AIAPI AIErr(* AIGroupSuite::SetGroupClipped)(AIArtHandle group, AIBoolean clipped)

Marks or unmarks a group as a clipping group; that is, sets or clears kArtIsClipMask for the group.

Use AIArtSuite::SetArtUserAttr() to mark clipping for individual contained paths.

Parameters:

	group	The art group object.
	clipped	True to turn clipping on for the group, false to turn clipping off.

AIAPI AIErr(* AIGroupSuite::SetGroupMaskLock)(AIArtHandle group, AIBoolean maskLocked)

Obsolete.

---

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

• AIGroup.h