AITabletDataSuite Struct Reference
[API Suite List]

This suite provides functions that allow you to access and manipulate tablet-device data that is attached to path objects. More...

Public Attributes
AIAPI AIErr(*	GetTabletData )(AIArtHandle path, AITabletProfile *profile, ai::int32 count, AITabletDataType type)
	Retrieves tablet data attached to a path.
AIAPI AIErr(*	SetTabletData )(AIArtHandle path, AITabletProfile *profile, ai::int32 count, AITabletDataType type)
	Sets tablet data for a path.
AIAPI AIErr(*	GetTabletDataInUse )(AIArtHandle path, AIBoolean *inUse)
	Reports whether tablet data is being stored with a path.
AIAPI AIErr(*	SetTabletDataInUse )(AIArtHandle path, AIBoolean inUse)
	Sets the state of tablet use for a path.
AIAPI AIErr(*	SplitTabletData )(AITabletProfile orig, ai::int32 origCount, AITabletProfile part1, ai::int32 part1Count, AITabletProfile *part2, ai::int32 part2Count, AIReal split)
	Splits a set of tablet data into two sets to go with the two parts of a split path.
AIAPI AIErr(*	ExtendTabletData )(AITabletProfile orig, ai::int32 origCount, AITabletProfile extendedProfile, ai::int32 extendedCount, AIReal newStart, AIReal newEnd)
	Extends the size of a set of tablet data.
AIAPI AIErr(*	JoinTabletData )(AITabletProfile part1, ai::int32 part1Count, AITabletProfile part2, ai::int32 part2Count, AITabletProfile *joined, ai::int32 joinedCount, AIReal part1Ends, AIReal part2Begins)
	Combines two sets of tablet data into a single set.

Detailed Description

This suite provides functions that allow you to access and manipulate tablet-device data that is attached to path objects.

Extends the size of a set of tablet data.

Parameters:

	orig	An array containing the original tablet data.
	origCount	The number of entries in the original data array.
	extendedProfile	[in, out] A buffer in which to pass additional profile data to merge with the original, and return the merged profile.
	extendedCount	[in, out] A buffer in which to pass then number of entries in the additional profile data and return the size of the merged profile.
	newStart	The index of the beginning of new data in the extended profile.
	newEnd	The index of the end of new data in the extended profile.

Retrieves tablet data attached to a path.

Parameters:

	path	The path object.
	profile	[in, out] An array in which to return the tablet data. If no data is present, this is set to `NULL` and `count` is set to 0. If the array is not large enough, `count` is set to the size of the array needed, and `kNotEnoughSpace` is returned.
	count	[in, out] The size of the array passed. On return, the number of entries filled in the array, or, if the passed array is not large enough, the size of the array needed.
	type	The type of tablet data to retrieve.

Returns:: kNotEnoughSpace error if the passed array is not large enough to hold the data.

Reports whether tablet data is being stored with a path.

Parameters:

	path	The path object.
	inUse	[out] A buffer in which to return true if a tablet is in use for the path.

Combines two sets of tablet data into a single set.

Parameters:

	part1	An array containing the first part of the tablet data.
	part1Count	The size of the part-one array.
	part2	An array containing the second part of the tablet data.
	part2Count	The size of the part-two array.
	joined	[out] An array in which to return the combined tablet data.
	joinedCount	[in, out] The size of the joined array. On return, the number of elements filled.
	part1Ends	A value between [0..1] which indicates the offset at which the first part of the tablet data ends. Must be less than or equal to `part2Begins`. Used to rescale the offsets in the new tablet data.
	part2Begins	A value between [0..1] which indicates the offset at which the second part of the tablet data begins. Must be greater than or equal to `part1Ends`. Used to rescale the offsets in the new tablet data.

Returns:: The error kNotEnoughSpace if the output array is not big enough to hold the returned data.

Sets tablet data for a path.

Parameters:

	path	The path object.
	profile	An array containing the tablet data.
	count	The size of the array passed.
	type	The type of the tablet data.

Sets the state of tablet use for a path.

Parameters:

	path	The path object.
	inUse	True if a tablet is in use for the path, false otherwise.

Splits a set of tablet data into two sets to go with the two parts of a split path.

Parameters:

	orig	An array containing the original tablet data.
	origCount	The number of entries in the original data array.
	part1	[out] An array in which to return the first part of the tablet data.
	part1Count	[in, out] The size of the part-one array. On return, the number of elements filled.
	part2	[in, out] An array in which to return the second part of the tablet data.
	part2Count	[in, out] The size of the part-two array. On return, the number of elements filled.
	split	A value between [0..1] which indicates the offset at which to split the data. A value of 0.5, for example, splits the data in half. Used to rescale the offsets in the new tablet data sets.

Returns:: The error kNotEnoughSpace if either output array is not big enough to hold the returned data.

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