AIMatchingArtSpec Struct Reference

A filter for matching art objects that contain specific properties. More...

#include <AIMatchingArt.h>

List of all members.

Public Member Functions
	AIMatchingArtSpec (ai::int32 _type=0, ai::int32 _whichattr=0, ai::int32 _attr=0)
Public Attributes
ai::int16	type
	An AIArtType that identifies the types of art objects that match the specification.
ai::int32	whichAttr
	An attribute and value by which to further filter art of the given type.
ai::int32	attr

---

Detailed Description

A filter for matching art objects that contain specific properties.

Pass an array of these structures to AIMatchingArtSuite functions to specify the art objects that should be returned.

Together, whichAttr and attr specify an attribute value that an art object of the given type must have to be considered a match.

• whichAttr is the desired attribute, one of the AIArtUserAttr values.
• attr is a mask for the desired state of the attribute. Pass 0 to match objects without the attribute. or the attribute constant to match objects with that attribute.

For example:

• Specify kArtSelected for both whichAttr and attr to match only art objects that are selected.
• Specify kArtSelected for whichAttr and 0 for attr to match only objects that are not selected.

Some values in AIArtUserAttr are not art attributes but instead specify additional options to the matching process. To use these options, specify the value in the whichAttr field of one specifications structure. For example, if the kMatchDictionaryArt flag is set in any specification, the search looks in the dictionaries of art objects, as well as in the objects themselves.

---

Constructor & Destructor Documentation

AIMatchingArtSpec::AIMatchingArtSpec	(	ai::int32	_type = 0,
		ai::int32	_whichattr = 0,
		ai::int32	_attr = 0
	)			[inline]

---

Member Data Documentation

ai::int32 AIMatchingArtSpec::attr

ai::int16 AIMatchingArtSpec::type

An AIArtType that identifies the types of art objects that match the specification.

Use the special type kAnyArt to match any kind of art object.

ai::int32 AIMatchingArtSpec::whichAttr

An attribute and value by which to further filter art of the given type.

---

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

• AIMatchingArt.h