AIMatchingArtSuite Struct Reference
[API Suite List]
This suite allows you to get lists of art objects that are currently selected, or that match specified criteria, from among all available art objects, or from artwork in a particular set of layers.
More...
#include <AIMatchingArt.h>
List of all members.
Public Attributes |
| AIAPI AIErr(* | GetSelectedArt )(AIArtHandle ***matches, ai::int32 *numMatches) |
| | Collects all selected art objects in the current layer list of the current document.
|
| AIAPI AIErr(* | GetMatchingArt )(AIMatchingArtSpec *specs, ai::int16 numSpecs, AIArtHandle ***matches, ai::int32 *numMatches) |
| | Collects an array of all art objects in the current layer list of the current document that match a set of criteria.
|
| AIAPI AIErr(* | GetSelectedArtFromLayerList )(AILayerList list, AIArtHandle ***matches, ai::int32 *numMatches) |
| | Collects all selected art objects in a given layer list of the current document.
|
| AIAPI AIErr(* | GetMatchingArtFromLayerList )(AILayerList list, AIMatchingArtSpec *specs, ai::int16 numSpecs, AIArtHandle ***matches, ai::int32 *numMatches) |
| | Collects an array of all art objects in a given layer list of the current document that match a set of criteria.
|
| AIAPI AIErr(* | GetArtForCurrentPathStyle )(AIArtHandle ***matches, ai::int32 *numMatches) |
| | Collects an array of all art objects in the current layer list of the current document that are used to determine the current path style, as displayed in the Color palette.
|
| AIAPI AIBoolean(* | IsSomeArtSelected )(void) |
| | Reports whether any art objects (as opposed to text objects) are selected in the current layer list of the current document, when the document is not in text editing mode.
|
| AIAPI AIErr(* | GetMatchingArtFromArt )(AIArtHandle searchArt, AIMatchingArtSpec *specs, ai::int16 numSpecs, AIArtHandle ***matches, ai::int32 *numMatches) |
| | Collects an array of all art objects in a given artwork tree that match a set of criteria.
|
| AIAPI AIErr(* | DeselectAll )(void) |
| | Deselects all objects in the current document.
|
Detailed Description
This suite allows you to get lists of art objects that are currently selected, or that match specified criteria, from among all available art objects, or from artwork in a particular set of layers.
It provides an additional collection mechanism to those in the AIArtSuite and AIArtSetSuite, and is more convenient than traversing the entire artwork tree.
These functions return art in an array of AIArtHandle. The suite allocates a memory block for this array, which you must release using AIMdMemorySuite::MdMemoryDisposeHandle(). Do not free the individual members of the array.
The functions flatten the requested hierarchy of objects into one art object array, which can contain any combination of atomic objects, such as paths, and compound objects, such as groups.
Your plug-in must handle the case of a group that is partially selected--that is, some but not all members are selected. In this case, both the group and some of its contained art objects are in the returned object array. If, for example, your plug-in moves the objects in a group, you must ignore the member objects in the array so that they are not moved twice.
Member Data Documentation
Deselects all objects in the current document.
Collects an array of all art objects in the current layer list of the current document that are used to determine the current path style, as displayed in the Color palette.
The current path style is determined by a combination of the targeted and selected objects. The returned art can include objects inside graphs.
- Parameters:
-
| matches | [out] A buffer in which to return a pointer to a block of memory containing the array of matching art objects. You must release the memory block when you no longer need it using AIMdMemorySuite::MdMemoryDisposeHandle(). Do not free the individual members of the array. |
| numMatches | [in/out] A buffer in which to pass the size of the matches array, and return the number of art objects collected. If no objects are selected, returns 0. |
Collects an array of all art objects in the current layer list of the current document that match a set of criteria.
- Parameters:
-
| specs | An array of match specifications. |
| numSpecs | The number of entries in the specs array. |
| matches | [out] A buffer in which to return a pointer to a block of memory containing the array of matching art objects. You must release the memory block when you no longer need it using AIMdMemorySuite::MdMemoryDisposeHandle(). Do not free the individual members of the array. |
| numMatches | [in/out] A buffer in which to pass the size of the matches array, and return the number of art objects collected. If no objects are selected, returns 0. |
Collects an array of all art objects in a given artwork tree that match a set of criteria.
Use to perform a narrower search, or to search in art that is not part of the regular artwork tree, such as definition art for a pattern, brush, or symbol.
- Parameters:
-
| searchArt | The root art object. |
| specs | An array of match specifications. |
| numSpecs | The number of entries in the specs array. |
| matches | [out] A buffer in which to return a pointer to a block of memory containing the array of matching art objects. You must release the memory block when you no longer need it using AIMdMemorySuite::MdMemoryDisposeHandle(). Do not free the individual members of the array. |
| numMatches | [in/out] A buffer in which to pass the size of the matches array, and return the number of art objects collected. If no objects are selected, returns 0. |
Collects an array of all art objects in a given layer list of the current document that match a set of criteria.
- Parameters:
-
| list | The layer list. |
| specs | An array of match specifications. |
| numSpecs | The number of entries in the specs array. |
| matches | [out] A buffer in which to return a pointer to a block of memory containing the array of matching art objects. You must release the memory block when you no longer need it using AIMdMemorySuite::MdMemoryDisposeHandle(). Do not free the individual members of the array. |
| numMatches | [in/out] A buffer in which to pass the size of the matches array, and return the number of art objects collected. If no objects are selected, returns 0. |
Collects all selected art objects in the current layer list of the current document.
- Parameters:
-
| matches | [out] A buffer in which to return a pointer to a block of memory containing the array of matching art objects. You must release the memory block when you no longer need it using AIMdMemorySuite::MdMemoryDisposeHandle(). Do not free the individual members of the array. This may be NULL if you do not want the actual matches (but only the count, for instance). |
| numMatches | [in/out] A buffer in which to pass the size of the matches array, and return the number of art objects collected. If no objects are selected, returns 0. |
Collects all selected art objects in a given layer list of the current document.
- Parameters:
-
| list | The layer list. |
| matches | [out] A buffer in which to return a pointer to a block of memory containing the array of matching art objects. You must release the memory block when you no longer need it using AIMdMemorySuite::MdMemoryDisposeHandle(). Do not free the individual members of the array. |
| numMatches | [in/out] A buffer in which to pass the size of the matches array, and return the number of art objects collected. If no objects are selected, returns 0. |
Reports whether any art objects (as opposed to text objects) are selected in the current layer list of the current document, when the document is not in text editing mode.
(Note that this function returns a boolean value, not an error code.)
- Returns:
- True if any art objects are selected, false if there is a text editing selection or if no objects are selected.
- Note:
- To test whether there is a text editing selection, call
AIDocumentSuite::HasTextFocus().
The documentation for this struct was generated from the following file:
