|
AIIsolationModeSuite Struct Reference
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Public Attributes | |
| AIAPI AIErr(* | EnterIsolationMode )(AIArtHandle art, AIBoolean invisibleFlag) |
| Enters isolation mode for a specific group or plug-in group. | |
| AIAPI AIErr(* | ExitIsolationMode )(void) |
| Exits isolation mode and returns to normal editing mode. | |
| AIAPI void(* | GetIsolatedArtAndParents )(AIArtHandle *isolatedArtParent, ai::AutoBuffer< AIArtHandle > *parentChain) |
Retrieves the original parent and ancestors of an isolated artwork tree; that is, the pre-isolation parent of a group, plugin-group or other art that has been passed to EnterIsolationMode(). | |
| AIAPI ASBoolean(* | IsInIsolationMode )(void) |
| Reports whether isolation mode is in effect. | |
| AIAPI ASBoolean(* | IsIsolatedLayer )(AIArtHandle art) |
| Reports whether artwork is in the isolated layer. | |
| AIAPI ASBoolean(* | IsNonIsolatedLayer )(AIArtHandle art) |
| Reports whether artwork is in a non-isolated layer. | |
| AIAPI ASBoolean(* | CanIsolateArt )(AIArtHandle art) |
| Reports whether an art tree is a legal target for isolation mode. | |
| AIAPI AIIsolationModeType(* | GetIsolationModeType )() |
| Reports the type art in Isolation Mode. | |
| AIAPI AIErr(* | CancelIsolationMode )(void) |
Identical to ExitIsolationMode(), except that after restoring the parent chain, a kAIIsolationModeChangedNotifier message is sent with canceled as true. | |
| AIAPI AIErr(* | SetNonIsolatedArtLayerOpacity )(const AIReal inNewOpacity) |
| Sets the opacity value applied to the non-isolated art layers. | |
| AIAPI AIReal(* | GetNonIsolatedArtLayerOpacity )() |
| Gets the current opacity value applied to the non-isolated art layers. | |
This suite provides functions that handle isolation mode, in which an artwork selection is moved onto a special isolation layer for editing, and that isolation layer (and any contents) becomes the only layer displayed in the Layers panel or accessible to edits.
See AILayerListSuite.
SPBasicSuite::AcquireSuite() with the constants kAIIsolationModeSuite and kAIIsolationModeVersion. | AIAPI AIErr(* AIIsolationModeSuite::CancelIsolationMode)(void) |
Identical to ExitIsolationMode(), except that after restoring the parent chain, a kAIIsolationModeChangedNotifier message is sent with canceled as true.
For normal isolation mode, there is no difference in behavior, since even when canceled, any changes made in isolation mode are not rolled back. For Symbol editing mode and Pattern editing mode, the symbol or pattern is ordinarily redefined during handling of the kAIIsolationModeChangedNotifier. Canceling causes the redefinition not to occur.
| AIAPI ASBoolean(* AIIsolationModeSuite::CanIsolateArt)(AIArtHandle art) |
Reports whether an art tree is a legal target for isolation mode.
Art that cannot be isolated includes, for example, art that is inside a plug-in group or dictionary, text art or guides, art that is locked or hidden, template layers, and the temporary isolation layer of an object already in isolation mode. If art is null, returns whether it is legal to enter isolation mode in general. (Under some conditions it is invalid to enter isolation mode on anything, such as when already in mask editing mode.)
| art | The parent art object of the art tree, or null. |
| AIAPI AIErr(* AIIsolationModeSuite::EnterIsolationMode)(AIArtHandle art, AIBoolean invisibleFlag) |
Enters isolation mode for a specific group or plug-in group.
This art becomes the isolated art, replacing any art that was previously isolated. In this mode, the user can edit only the isolated art.
While the art is isolated, AIArtSuite::GetArtParent() returns the layer group of the temporary isolation layer; use GetIsolatedArtAndParents() instead to retrieve the pre-isolation parent.
| art | The group or plug-in group art object. Can be in the main art tree or in an isolated art tree. Cannot be art inside a dictionary or plug-in group. | |
| invisibleFlag | When true, artwork that is not isolated is made invisible. When false, non-isolated artwork is dimmed. |
| AIAPI AIErr(* AIIsolationModeSuite::ExitIsolationMode)(void) |
Exits isolation mode and returns to normal editing mode.
Any art on the isolation layer is reordered to where the art object passed to EnterIsolationMode() was originally located in the art tree. (It is therefore valid to delete the isolated art or add additional objects before exiting isolation mode.) After restoring the parent chain, a kAIIsolationModeChangedNotifier is sent with canceled as false. See also CancelIsolationMode().
| AIAPI void(* AIIsolationModeSuite::GetIsolatedArtAndParents)(AIArtHandle *isolatedArtParent, ai::AutoBuffer< AIArtHandle > *parentChain) |
Retrieves the original parent and ancestors of an isolated artwork tree; that is, the pre-isolation parent of a group, plugin-group or other art that has been passed to EnterIsolationMode().
(Note that this function does not return an error code.)
| isolatedArtParent | [out] A buffer in which to return the parent art object of the isolated art tree. | |
| parentChain | [out] Optional. A buffer in which to return an array of 0 or more art objects (AIArtHandle) for the ancestors of the parent art object. |
Reports the type art in Isolation Mode.
AIIsolationModeType constant Gets the current opacity value applied to the non-isolated art layers.
Note that this function returns a numeric opacity value, not an error code.
| AIAPI ASBoolean(* AIIsolationModeSuite::IsInIsolationMode)(void) |
Reports whether isolation mode is in effect.
(Note that this function returns a boolean value, not an error code.)
| AIAPI ASBoolean(* AIIsolationModeSuite::IsIsolatedLayer)(AIArtHandle art) |
Reports whether artwork is in the isolated layer.
(Note that this function returns a boolean value, not an error code.)
| art | The parent art object of the art tree. |
| AIAPI ASBoolean(* AIIsolationModeSuite::IsNonIsolatedLayer)(AIArtHandle art) |
Reports whether artwork is in a non-isolated layer.
Non-isolated art layers hold the artwork that is not being edited in isolation mode. Non-isolated artwork can be shown in a 50% opacity state in isolation mode, or can be hidden entirely when in symbol editing mode or pattern editing mode. The Layers panel uses this function to exclude non-isolated layers from the panel list. (Note that this function returns a boolean value, not an error code.)
| art | The parent art object of the art tree. |
| AIAPI AIErr(* AIIsolationModeSuite::SetNonIsolatedArtLayerOpacity)(const AIReal inNewOpacity) |
Sets the opacity value applied to the non-isolated art layers.
| inNewOpacity | The new opacity value, in the range [0..1] where 0 is completely transparent and 1 is completely opaque. |
| Contents | Suites | Classes | Class Index | Member Index |
 |
||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||
