Adobe.com
Contents Suites Classes Class Index Member Index

AIArtSpec Struct Reference

An AIArtSpec is a filter for matching art objects that have specific properties. More...

#include <AIArtSet.h>

List of all members.

Public Attributes

ai::int16 type
 The type of art object to match, an AIArtSuite::AIArtType value.
ai::int32 whichAttr
 AIArtSuite::AIArtUserAttr values for which attributes to consider (whichAttr) and for the matching value (attr).
ai::int32 attr

Detailed Description

An AIArtSpec is a filter for matching art objects that have specific properties.

Pass an array of these to AIArtSetSuite::MatchingArtSet() to specify the art objects that should be returned. Specify the type of art object to match, then filter objects of that type based on their user attributes.

  • Use the special type kAnyArt to match any kind of art object.
  • whichAttr specifies the collection of attributes to be considered when filtering objects.
  • attr specifies the values those attributes must have to match an object.

For example, specify kSelected for both whichAttr and attr to match only art objects that are selected.

Some AIArtSuite::AIArtUserAttr values are not art attributes but instead specify additional matching options. Use such a value in the whichAttr field; it only needs to be in one of the art specifications.


Member Data Documentation

ai::int32 AIArtSpec::attr
ai::int16 AIArtSpec::type

The type of art object to match, an AIArtSuite::AIArtType value.

AIArtSuite::AIArtUserAttr values for which attributes to consider (whichAttr) and for the matching value (attr).


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


Contents Suites Classes Class Index Member Index
Adobe Solutions Network
 
Copyright © 2014 Adobe Systems Incorporated. All rights reserved.
Terms of Use Online Privacy Policy Adobe and accessibility Avoid software piracy Permissions and Trademarks