AISlicingSuite Struct Reference
[API Suite List]

This suite provides functions that allow you to create and manipulate image slices, subsets of raster data that can be used in copying from one buffer to another. More...

#include <AISlicing.h>

List of all members.

Public Attributes
AIAPI AIErr(*	MakeSlice )(AIArtHandle art, ai::int32 *sliceID, AIBoolean fromPlace)
	Designates an art object as a slice.
AIAPI AIErr(*	CreateSlice )(AIArtHandle placeAboveArt, ai::int32 *sliceID, AIBoolean selected, AIBoolean fromPlace)
	Creates a rectangle with no fill and no stroke and makes it a slice.
AIAPI AIErr(*	DeleteSlice )(ai::int32 sliceID)
	Deletes slice art and its slicing information.
AIAPI AIErr(*	Unslice )(AIArtHandle art)
	Removes the slicing designation from an art object, but does not delete the art.
AIAPI ai::int32(*	GetArtSliceID )(AIArtHandle art)
	Retrieves the unique slice identifier of an art object.
AIAPI AIArtHandle(*	GetSliceArt )(ai::int32 sliceID)
	Retrieves the art object for a slice (Note that this function returns an object value, not an error code.
AIAPI ai::int32(*	GetUniqueSliceID )(void)
	Retrieves a unique identifier suitable for a slice.
AIAPI AIBoolean(*	SliceExists )(ai::int32 sliceID)
	Reports whether a unique identifier is currently used to identify a slice.
AIAPI ai::int32(*	GetSliceCount )(void)
	Retrieves the number of slices in the slice list.
AIAPI ai::int32(*	GetIndexedSliceID )(ai::int32 index)
	Retrieves a slice from the slice list by position index.
AIAPI AIErr(*	SetSliceBounds )(ai::int32 sliceID, AIRealRect *boundsRect)
	Sets the bounding rectangle for a no fill/no stroke slice.
AIAPI AIErr(*	GetSliceBounds )(ai::int32 sliceID, AIRealRect *boundsRect)
	Retrieves the bounding rectangle for a slice, including the border.
AIAPI AIErr(*	SetSliceBorder )(ai::int32 sliceID, AIRealRect *borderRect)
	Sets a border for a slice, which is the appended to the art visual bounds to generate the slice bounds.
AIAPI AIErr(*	GetSliceBorder )(ai::int32 sliceID, AIRealRect *borderRect)
	Retrieves the border rectangle for a slice.
AIAPI AIErr(*	SetSliceSettings )(ai::int32 sliceID, ASSliceSettings *settings)
	Set the definition information for a slice.
AIAPI AIErr(*	GetSliceSettings )(ai::int32 sliceID, ASSliceSettings *settings)
	Retrieves the definition information for a slice.
AIAPI AIErr(*	SetSliceSetting )(ai::int32 sliceID, const AIDictKey &key, AIEntryRef valueEntry)
	Sets a single slice attribute.
AIAPI AIErr(*	GetSliceSetting )(ai::int32 sliceID, const AIDictKey &key, AIEntryRef *valueEntry)
	Retrieves a single slice attribute.
AIAPI AIBoolean(*	SliceIsText )(ai::int32 sliceID)
	Reports whether a slice can be converted to text.
AIAPI AIErr(*	SetSliceIsHTMLText )(ai::int32 sliceID, ai::int32 HTMLTextOptions)
	Marks a slice so that it is converted to HTML text on output.
AIAPI AIBoolean(*	GetSliceIsHTMLText )(ai::int32 sliceID, ai::int32 *HTMLTextOptions)
	Reports whether a slice is converted to HTML text on output.
AIAPI AIErr(*	GetSliceAsHTMLText )(ai::int32 sliceID, ai::int32 options, ASHandle *text)
	Converts a slice to text.
AIAPI AIBoolean(*	SliceIsOnLayer )(ai::int32 sliceID, AILayerHandle layer)
	Reports whether a slice is on a given layer.
AIAPI AIErr(*	ReplaceSliceList )(ai::int32 groupID, AISavedSliceListRef *oldSliceList)
	Temporarily replaces the slice list with an empty slice list and the optimizations list with the settings of a specified slice.
AIAPI AIErr(*	RestoreSliceList )(AISavedSliceListRef oldSliceList)
	Restores the slice list after a call to `ReplaceSliceList()`.
AIAPI AIBoolean(*	SliceIsSelected )(ai::int32 sliceID)
	Reports whether a slice is selected.
AIAPI AIErr(*	GetSelectedSliceList )(ai::int32 *sliceIDList, ai::int32 count)
	Retrieves all selected slices.
AIAPI AIErr(*	ReleaseSelectedSliceList )(ai::int32 *sliceIDList)
	Frees memory allocated for a slice list by `GetSelectedSliceList()`.
AIAPI AIErr(*	DuplicateArtWithinRect )(AIRealRect sliceBounds, AIArtHandle outputGroup)
	Duplicates all artwork in the current document that lies within a rectangle, and adds it to a specified art group.
AIAPI AIErr(*	TransferSliceAttributes )(AIArtHandle srcart, AIArtHandle dstart)
	Transfers the slicing attributes from one art object to another.

Detailed Description

This suite provides functions that allow you to create and manipulate image slices, subsets of raster data that can be used in copying from one buffer to another.

Acquire this suite using SPBasicSuite::AcquireSuite() with the constants kAISlicingSuite and kAISlicingSuiteVersion.

Member Data Documentation

AIAPI AIErr(* AISlicingSuite::CreateSlice)(AIArtHandle placeAboveArt, ai::int32 *sliceID, AIBoolean selected, AIBoolean fromPlace)

Creates a rectangle with no fill and no stroke and makes it a slice.

Parameters:

	placeAboveArt	The art object above which to place the new slice in the paint order.
	sliceID	[in, out] Optionally, a unique identifier to use if possible. Upon return, the unique identifier actually assigned to the new slice.
	selected	True to select the new slice.
	fromPlace	True if called from a plug-in file format. False if called from a menu or tool.

AIAPI AIErr(* AISlicingSuite::DeleteSlice)(ai::int32 sliceID)

Deletes slice art and its slicing information.

Parameters:

sliceID

The unique identifier of the slice, as assigned on creation.

AIAPI AIErr(* AISlicingSuite::DuplicateArtWithinRect)(AIRealRect sliceBounds, AIArtHandle outputGroup)

Duplicates all artwork in the current document that lies within a rectangle, and adds it to a specified art group.

Parameters:

	sliceBounds	The bounding rectangle.
	outputGroup	The group art object.

AIAPI ai::int32(* AISlicingSuite::GetArtSliceID)(AIArtHandle art)

Retrieves the unique slice identifier of an art object.

(Note that this function returns a numeric value, not an error code.)

Parameters:

art

The art object.

Returns:: The unique slice identifier, or kInvalidSliceID if the art is not a slice.

AIAPI ai::int32(* AISlicingSuite::GetIndexedSliceID)(ai::int32 index)

Retrieves a slice from the slice list by position index.

Use with GetSliceCount() to iterate through slices. (Note that this function returns a numeric value, not an error code.)

Parameters:

index

The 0-based position index.

Returns:: The unique slice identifier.

AIAPI AIErr(* AISlicingSuite::GetSelectedSliceList)(ai::int32 **sliceIDList, ai::int32 *count)

Retrieves all selected slices.

Parameters:

	sliceIDList	[out] A buffer in which to return an array of unique slice identifiers.
	count	[out] A buffer in which to return the number of entries in the array.

AIAPI AIArtHandle(* AISlicingSuite::GetSliceArt)(ai::int32 sliceID)

Retrieves the art object for a slice (Note that this function returns an object value, not an error code.

)

Parameters:

sliceID

The unique slice identifier.

Returns:: The associated art object, or NULL if there is no such slice.

AIAPI AIErr(* AISlicingSuite::GetSliceAsHTMLText)(ai::int32 sliceID, ai::int32 options, ASHandle *text)

Converts a slice to text.

Parameters:

	sliceID	The unique slice identifier.
	options	The text conversion options, a logical OR of `AIHTMLConversionOptions` values.
	text	[out] A buffer in which to return the text object. The call allocates and frees the text handle; you can resize it using `AIPlatformMemorySuite::Resize()`.

AIAPI AIErr(* AISlicingSuite::GetSliceBorder)(ai::int32 sliceID, AIRealRect *borderRect)

Retrieves the border rectangle for a slice.

Parameters:

	sliceID	The unique slice identifier.
	borderRect	[out] A buffer in which to return the border rectangle.

AIAPI AIErr(* AISlicingSuite::GetSliceBounds)(ai::int32 sliceID, AIRealRect *boundsRect)

Retrieves the bounding rectangle for a slice, including the border.

Parameters:

	sliceID	The unique slice identifier.
	boundsRect	[out] A buffer in which to return the bounding rectangle.

AIAPI ai::int32(* AISlicingSuite::GetSliceCount)(void)

Retrieves the number of slices in the slice list.

Use with GetIndexedSliceID() to iterate through slices. (Note that this function returns a numeric value, not an error code.)

Returns:: The number of slices.

AIAPI AIBoolean(* AISlicingSuite::GetSliceIsHTMLText)(ai::int32 sliceID, ai::int32 *HTMLTextOptions)

Reports whether a slice is converted to HTML text on output.

(Note that this function returns a boolean value, not an error code.)

Parameters:

	sliceID	The unique slice identifier.
	HTMLTextOptions	[out] A buffer in which to return the text conversion options, a logical OR of `AIHTMLConversionOptions` values.

Returns:: True if the slice is marked to be converted to HTML text, false otherwise.

AIAPI AIErr(* AISlicingSuite::GetSliceSetting)(ai::int32 sliceID, const AIDictKey &key, AIEntryRef *valueEntry)

Retrieves a single slice attribute.

Parameters:

	sliceID	The unique slice identifier.
	key	The slice information attribute key.
	valueEntry	[out] A buffer in which to return the attribute value.

AIAPI AIErr(* AISlicingSuite::GetSliceSettings)(ai::int32 sliceID, ASSliceSettings *settings)

Retrieves the definition information for a slice.

Parameters:

	sliceID	The unique slice identifier.
	settings	[out] A buffer in which to return the information.

AIAPI ai::int32(* AISlicingSuite::GetUniqueSliceID)(void)

Retrieves a unique identifier suitable for a slice.

(Note that this function returns a numeric value, not an error code.)

Returns:: A unique slice identifier.

AIAPI AIErr(* AISlicingSuite::MakeSlice)(AIArtHandle art, ai::int32 *sliceID, AIBoolean fromPlace)

Designates an art object as a slice.

Parameters:

	art	The art object.
	sliceID	[in, out] Optionally, a unique identifier to use if possible. Upon return, the unique slice identifier actually assigned.
	fromPlace	True if called from a plug-in file format. False if called from a menu or tool.

AIAPI AIErr(* AISlicingSuite::ReleaseSelectedSliceList)(ai::int32 *sliceIDList)

Frees memory allocated for a slice list by GetSelectedSliceList().

Parameters:

sliceIDList

The slice list.

AIAPI AIErr(* AISlicingSuite::ReplaceSliceList)(ai::int32 groupID, AISavedSliceListRef *oldSliceList)

Temporarily replaces the slice list with an empty slice list and the optimizations list with the settings of a specified slice.

Parameters:

	groupID	The unique slice identifier. <<right? why "group"?>>
	oldSliceList	[out] A buffer in which to return an opaque references to the current full lists, to be passed to `RestoreSliceList()`.

AIAPI AIErr(* AISlicingSuite::RestoreSliceList)(AISavedSliceListRef oldSliceList)

Restores the slice list after a call to ReplaceSliceList().

Parameters:

oldSliceList

The slice list to restore.

AIAPI AIErr(* AISlicingSuite::SetSliceBorder)(ai::int32 sliceID, AIRealRect *borderRect)

Sets a border for a slice, which is the appended to the art visual bounds to generate the slice bounds.

Parameters:

	sliceID	The unique slice identifier.
	borderRect	The new border rectangle.

AIAPI AIErr(* AISlicingSuite::SetSliceBounds)(ai::int32 sliceID, AIRealRect *boundsRect)

Sets the bounding rectangle for a no fill/no stroke slice.

Does not affect a slice associated with any other art.

Parameters:

	sliceID	The unique slice identifier.
	boundsRect	The new bounding rectangle.

AIAPI AIErr(* AISlicingSuite::SetSliceIsHTMLText)(ai::int32 sliceID, ai::int32 HTMLTextOptions)

Marks a slice so that it is converted to HTML text on output.

Parameters:

	sliceID	The unique slice identifier.
	HTMLTextOptions	The text conversion options, a logical OR of `AIHTMLConversionOptions` values.

AIAPI AIErr(* AISlicingSuite::SetSliceSetting)(ai::int32 sliceID, const AIDictKey &key, AIEntryRef valueEntry)

Sets a single slice attribute.

Parameters:

	sliceID	The unique slice identifier.
	key	The slice information attribute key.
	valueEntry	The new attribute value.

AIAPI AIErr(* AISlicingSuite::SetSliceSettings)(ai::int32 sliceID, ASSliceSettings *settings)

Set the definition information for a slice.

Parameters:

	sliceID	The unique slice identifier.
	settings	The new slice information.

AIAPI AIBoolean(* AISlicingSuite::SliceExists)(ai::int32 sliceID)

Reports whether a unique identifier is currently used to identify a slice.

(Note that this function returns a boolean value, not an error code.)

Parameters:

sliceID

The slice identifier.

Returns:: True if the identifier is in use.

AIAPI AIBoolean(* AISlicingSuite::SliceIsOnLayer)(ai::int32 sliceID, AILayerHandle layer)

Reports whether a slice is on a given layer.

(Note that this function returns a boolean value, not an error code.)

Parameters:

	sliceID	The unique slice identifier.
	layer	The layer.

Returns:: True if the slice is on the layer.

AIAPI AIBoolean(* AISlicingSuite::SliceIsSelected)(ai::int32 sliceID)

Reports whether a slice is selected.

(Note that this function returns a boolean value, not an error code.)

Parameters:

sliceID

The unique slice identifier.

Returns:: True if the slice is selected.

AIAPI AIBoolean(* AISlicingSuite::SliceIsText)(ai::int32 sliceID)

Reports whether a slice can be converted to text.

(Note that this function returns a boolean value, not an error code.)

Parameters:

sliceID

The unique slice identifier.

Returns:: True if the slice can be converted to text.

AIAPI AIErr(* AISlicingSuite::TransferSliceAttributes)(AIArtHandle srcart, AIArtHandle dstart)

Transfers the slicing attributes from one art object to another.

Use with operations that create a new object that is intended replace the original and adopt its identity; for example, a conversion operation such as from a path to a gradient mesh. See also AIArtSuite::TransferAttributes().

Parameters:

	srcart	The source art object.
	dstart	The destination art object.

AIAPI AIErr(* AISlicingSuite::Unslice)(AIArtHandle art)

Removes the slicing designation from an art object, but does not delete the art.

Parameters:

art

The art object.

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

AISlicing.h

AISlicingSuite Struct Reference [API Suite List]

Public Attributes

Detailed Description

Member Data Documentation

AISlicingSuite Struct Reference
[API Suite List]