AIArtSetSuite Struct Reference
[API Suite List]

An art set is an ordered list of art object handles. More...

#include <AIArtSet.h>

Public Attributes
AIAPI AIErr(*	NewArtSet )(AIArtSet *artSet)
	Creates a new, empty art set.
AIAPI AIErr(*	DisposeArtSet )(AIArtSet *artSet)
	Frees memory associated with an art set and makes the reference null.
AIAPI AIErr(*	CountArtSet )(AIArtSet artSet, size_t *count)
	Gets the number of art handles stored in an art set.
AIAPI AIErr(*	IndexArtSet )(AIArtSet artSet, size_t index, AIArtHandle *art)
	Retrieves the art object at a given index within an art set.
AIAPI AIErr(*	ArrayArtSet )(AIArtSet artSet, AIArtHandle *artArray, size_t count)
	Fills an art set with an array of art objects.
AIAPI AIErr(*	SelectedArtSet )(AIArtSet artSet)
	Fills an art set with currently selected art.
AIAPI AIErr(*	MatchingArtSet )(AIArtSpec *specs, ai::int16 numSpecs, AIArtSet artSet)
	Fills an art set with the art objects in the current document that match the criteria given in a list of art specifications; see `AIArtSpec`.
AIAPI AIErr(*	LayerArtSet )(AILayerHandle layer, AIArtSet artSet)
	Fills an art set with all art objects that belong to a specific layer.
AIAPI AIErr(*	NotArtSet )(AIArtSet src, AIArtSet dst)
	Deprecated.
AIAPI AIErr(*	UnionArtSet )(AIArtSet src0, AIArtSet src1, AIArtSet dst)
	Fills an art set with all art objects contained in two art sets without duplicating common art objects.
AIAPI AIErr(*	IntersectArtSet )(AIArtSet src0, AIArtSet src1, AIArtSet dst)
	Fills an art set with all art objects that are common to two art sets.
AIAPI AIErr(*	NextInArtSet )(AIArtSet artSet, AIArtHandle prevArt, AIArtHandle *nextArt)
	Retrieves an art object from an art set.
AIAPI AIErr(*	AddArtToArtSet )(AIArtSet artSet, AIArtHandle art)
	Appends an art object to an art set if it is not already there.
AIAPI AIErr(*	RemoveArtFromArtSet )(AIArtSet artSet, AIArtHandle art)
	Removes all occurrences of an art object from an art set.
AIAPI AIErr(*	ReplaceArtInArtSet )(AIArtSet artSet, AIArtHandle oldArt, AIArtHandle newArt)
	Replaces the first occurrence of one art object in a set with another, or, if `oldArt` is not found, appends `newArt` to the set.
AIAPI AIErr(*	ClearArtSet )(AIArtSet artSet)
	Clears the art set.

Detailed Description

An art set is an ordered list of art object handles.

An art object handle should appear at most once in the list. This is enforced by most but not all of the functions for manipulating the set.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAIArtSetSuite and kAIArtSetVersion.

Member Data Documentation

AIAPI AIErr(* AIArtSetSuite::AddArtToArtSet)(AIArtSet artSet, AIArtHandle art)

Appends an art object to an art set if it is not already there.

Parameters:

	artSet	The art set.
	art	The art object.

AIAPI AIErr(* AIArtSetSuite::ArrayArtSet)(AIArtSet artSet, AIArtHandle *artArray, size_t count)

Fills an art set with an array of art objects.

The previous contents of the art set, if any, are lost. It is the caller's responsibility to ensure that the array does not contain duplicates.

Parameters:

	artSet	The art set.
	artArray	A pointer to an array of art objects. You must allocate memory for this array, and free it when it is no longer needed.
	count	The number of entries in `artArray`.

Referenced by ai::ArtSet::Impl::Impl().

AIAPI AIErr(* AIArtSetSuite::ClearArtSet)(AIArtSet artSet)

Clears the art set.

Parameters:

artSet

The art set.

Referenced by ai::ArtSet::Impl::clear().

AIAPI AIErr(* AIArtSetSuite::CountArtSet)(AIArtSet artSet, size_t *count)

Gets the number of art handles stored in an art set.

Use with IndexArtSet() to iterate through a set.

Parameters:

	artSet	The art set.
	count	[out] A buffer in which to return the number of art handles.

Referenced by ai::ArtSet::Impl::size().

AIAPI AIErr(* AIArtSetSuite::DisposeArtSet)(AIArtSet *artSet)

Frees memory associated with an art set and makes the reference null.

Does not affect any artwork referenced by the set.

Parameters:

artSet

A pointer to the art set. Upon return, this reference is invalid.

Referenced by ai::ArtSet::Impl::~Impl().

AIAPI AIErr(* AIArtSetSuite::IndexArtSet)(AIArtSet artSet, size_t index, AIArtHandle *art)

Retrieves the art object at a given index within an art set.

Use with CountArtSet() to iterate through a set. This is the most efficient way to access elements of an art set. Access speed is O(1).

Parameters:

	artSet	The art set.
	index	The 0-based position index, in the range [0..count-1].
	art	[out] A buffer in which to return the art object.

Note:: ReplaceArtInArtSet() can put NULL entries into an art set. NextInArtSet() iterates through the set skipping NULL entries, but is not a efficient as this function.

Referenced by ai::ArtSet::Impl::at(), and ai::ArtSet::Impl::operator[]().

AIAPI AIErr(* AIArtSetSuite::IntersectArtSet)(AIArtSet src0, AIArtSet src1, AIArtSet dst)

Fills an art set with all art objects that are common to two art sets.

Parameters:

	src0	The first source art set.
	src1	The second source art set.
	dst	The destination art set.

AIAPI AIErr(* AIArtSetSuite::LayerArtSet)(AILayerHandle layer, AIArtSet artSet)

Fills an art set with all art objects that belong to a specific layer.

The previous contents of the art set, if any, are lost.

Parameters:

	layer	The layer.
	artSet	The art set.

Referenced by ai::ArtSet::Impl::Impl().

AIAPI AIErr(* AIArtSetSuite::MatchingArtSet)(AIArtSpec *specs, ai::int16 numSpecs, AIArtSet artSet)

Fills an art set with the art objects in the current document that match the criteria given in a list of art specifications; see AIArtSpec.

The art objects are added to the set in the order they are encountered by a pre-order traversal of the document tree. An art object is included if it matches any of the art specifications.

Parameters:

	spec	A pointer to an array of `AIArtSpec` structures.
	numSpecs	The number of entries in `specs`.
	artSet	The art set.

Referenced by ai::ArtSet::Impl::Impl().

AIAPI AIErr(* AIArtSetSuite::NewArtSet)(AIArtSet *artSet)

Creates a new, empty art set.

This is an opaque pointer and cannot be dereferenced. Use functions in this suite to fill the set with art objects and access them.

Parameters:

artSet

[out] A buffer in which to return the new art set.

Referenced by ai::ArtSet::Impl::Impl().

AIAPI AIErr(* AIArtSetSuite::NextInArtSet)(AIArtSet artSet, AIArtHandle prevArt, AIArtHandle *nextArt)

Retrieves an art object from an art set.

Use this function to iterate through the objects in an art set. Unlike IndexArtSet() this function skips NULL entries in the set, but it is not as efficient; access speed is O(n). Use IndexArtSet() if possible.

Parameters:

	artSet	The art set.
	prevArt	An art object contained in the set, or `NULL` to get the first object.
	nextArt	[out] A buffer in which to return the next art object, or a null object if `prevArt` is not in the set or is the last member.

AIAPI AIErr(* AIArtSetSuite::NotArtSet)(AIArtSet src, AIArtSet dst)

Deprecated.

Fills an art set dst with all artwork in the document that is not in the art set src.

Note:: This function has not been kept up to date with changes to the object model.

AIAPI AIErr(* AIArtSetSuite::RemoveArtFromArtSet)(AIArtSet artSet, AIArtHandle art)

Removes all occurrences of an art object from an art set.

Parameters:

	artSet	The art set.
	art	The art object.

Referenced by ai::ArtSet::Impl::erase().

AIAPI AIErr(* AIArtSetSuite::ReplaceArtInArtSet)(AIArtSet artSet, AIArtHandle oldArt, AIArtHandle newArt)

Replaces the first occurrence of one art object in a set with another, or, if oldArt is not found, appends newArt to the set.

Parameters:

	artSet	The art set.
	oldArt	The art object to replace, if found.
	newArt	The art object to add. Can be `NULL`, in which case a null entry is inserted or added to the set

AIAPI AIErr(* AIArtSetSuite::SelectedArtSet)(AIArtSet artSet)

Fills an art set with currently selected art.

The previous contents of the art set, if any, are lost. Many filters operate on the selected objects in a document. Use this function to collect the selected art objects without having to iterate through the artwork tree to find them.It is the same as calling MatchingArtSet() with a request for { kAnyArt, kArtSelected, kArtSelected }

Parameters:

artSet

The art set.

Referenced by ai::ArtSet::Impl::Impl().

AIAPI AIErr(* AIArtSetSuite::UnionArtSet)(AIArtSet src0, AIArtSet src1, AIArtSet dst)

Fills an art set with all art objects contained in two art sets without duplicating common art objects.

Parameters:

	src0	The first source art set.
	src1	The second source art set.
	dst	The destination art set.

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

AIArtSet.h

AIArtSetSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AIArtSetSuite Struct Reference
[API Suite List]