AIMesh.h File Reference

#include "AITypes.h"
#include "AIArt.h"
#include "AIColor.h"
#include "AIHitTest.h"
#include "AIRealBezier.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AIMeshSuite
	This suite and related suites provides functions for creating and managing mesh objects, which are art object of type kMeshArt. More...
struct	AIMeshHitSuite
	This suite provides functions that operate on hit objects obtained by AIHitTestSuite functions, when the result of the test is a hit on a mesh object. More...
struct	AIMeshSelectionSuite
	This suite provides functions that allow you to create and manipulate mesh selections, which identify a subset of the vertices and segments of a mesh. More...
struct	AIMeshPatchIteratorSuite
	This suite provides functions that allow you to traverse and manipulate the patches in a mesh through a reference-counted iterator object. More...
struct	AIMeshVertexIteratorSuite
	This suite provides functions that allow you to traverse and manipulate the vertices in a mesh through a reference-counted iterator object. More...
struct	AIMeshSegmentIteratorSuite
	This suite provides functions that allow you to traverse and manipulate the segments in a mesh through a reference-counted iterator object. More...
Defines
#define	kAIMeshSuite   "AI Mesh Suite"
#define	kAIMeshSuiteVersion6   AIAPI_VERSION(6)
#define	kAIMeshSuiteVersion   kAIMeshSuiteVersion6
#define	kAIMeshVersion   kAIMeshSuiteVersion
#define	kAIMeshHitSuite   "AI Mesh Hit Suite"
#define	kAIMeshHitSuiteVersion3   AIAPI_VERSION(3)
#define	kAIMeshHitSuiteVersion   kAIMeshHitSuiteVersion3
#define	kAIMeshHitVersion   kAIMeshHitSuiteVersion
#define	kAIMeshSelectionSuite   "AI Mesh Selection Suite"
#define	kAIMeshSelectionSuiteVersion3   AIAPI_VERSION(3)
#define	kAIMeshSelectionSuiteVersion   kAIMeshSelectionSuiteVersion3
#define	kAIMeshSelectionVersion   kAIMeshSelectionSuiteVersion
#define	kAIMeshPatchIteratorSuite   "AI Mesh Patch Suite"
#define	kAIMeshPatchIteratorSuiteVersion3   AIAPI_VERSION(3)
#define	kAIMeshPatchIteratorSuiteVersion   kAIMeshPatchIteratorSuiteVersion3
#define	kAIMeshPatchIteratorVersion   kAIMeshPatchIteratorSuiteVersion
#define	kAIMeshVertexIteratorSuite   "AI Mesh Vertex Suite"
#define	kAIMeshVertexIteratorSuiteVersion4   AIAPI_VERSION(4)
#define	kAIMeshVertexIteratorSuiteVersion   kAIMeshVertexIteratorSuiteVersion4
#define	kAIMeshVertexIteratorVersion   kAIMeshVertexIteratorSuiteVersion
#define	kAIMeshSegmentIteratorSuite   "AI Mesh Segment Suite"
#define	kAIMeshSegmentIteratorSuiteVersion3   AIAPI_VERSION(3)
#define	kAIMeshSegmentIteratorSuiteVersion   kAIMeshSegmentIteratorSuiteVersion3
#define	kAIMeshSegmentIteratorVersion   kAIMeshSegmentIteratorSuiteVersion
Typedefs
typedef struct _AIMeshSelection *	AIMeshSelection
	Opaque reference to a mesh selection.
typedef struct _AIMeshPatchIterator *	AIMeshPatchIterator
	Opaque reference to a mesh patch iterator.
typedef struct _AIMeshVertexIterator *	AIMeshVertexIterator
	Opaque reference to a mesh vertex iterator.
typedef struct _AIMeshSegmentIterator *	AIMeshSegmentIterator
	Opaque reference to a mesh segment iterator.
typedef void(*	AIMeshPointMap )(AIRealPoint *point, void *userData)
	Transformation function prototype for AIMeshSuite::MapPoints() and AIMeshSelectionSuite::MapPoints() The function is assumed to have a continuous first derivative.
typedef void(*	AIMeshColorMap )(AIColor *color, void *userData)
	Transformation function prototype for AIMeshSuite::MapColors() and AIMeshSelectionSuite::MapColors().
typedef void(*	AIMeshColorQuery )(AIColor *color, void *userData)
	Color-query function prototype for AIMeshSuite::QueryColors() and AIMeshSelectionSuite::QueryColors().
Enumerations
enum	AIMeshKind { kAICartesianMesh = 0, kAIPolarMesh = 1 }
	Kinds of gradient mesh. More...
enum	AIMeshAxis { kAIMeshIAxis = 0, kAIMeshJAxis = 1 }
	Node axes. More...
enum	AIMeshAxisSense { kAIMeshAxisIncreasing = 0, kAIMeshAxisDecreasing = 1 }
	Directions along axes. More...
enum	AIMeshPatchDirection { kAIMeshClockwise = 0, kAIMeshCounterClockwise = 1 }
	Directions around patches. More...
enum	AIMeshPart {   kAIMeshNowhere = 0, kAIMeshVertex = 1, kAIMeshTangent = 2, kAIMeshEdge = 3,   kAIMeshPatch = 4 }
	Parts of a mesh that can be hit. More...
enum	AIMeshSelectionBoundsVariant { kAIMeshSelectionRigidBounds = 0 }
	Variants for selection bounds. More...

---

Detailed Description

---

Define Documentation

#define kAIMeshHitSuite   "AI Mesh Hit Suite"

#define kAIMeshHitSuiteVersion   kAIMeshHitSuiteVersion3

#define kAIMeshHitSuiteVersion3   AIAPI_VERSION(3)

#define kAIMeshHitVersion   kAIMeshHitSuiteVersion

#define kAIMeshPatchIteratorSuite   "AI Mesh Patch Suite"

#define kAIMeshPatchIteratorSuiteVersion   kAIMeshPatchIteratorSuiteVersion3

#define kAIMeshPatchIteratorSuiteVersion3   AIAPI_VERSION(3)

#define kAIMeshPatchIteratorVersion   kAIMeshPatchIteratorSuiteVersion

#define kAIMeshSegmentIteratorSuite   "AI Mesh Segment Suite"

#define kAIMeshSegmentIteratorSuiteVersion   kAIMeshSegmentIteratorSuiteVersion3

#define kAIMeshSegmentIteratorSuiteVersion3   AIAPI_VERSION(3)

#define kAIMeshSegmentIteratorVersion   kAIMeshSegmentIteratorSuiteVersion

#define kAIMeshSelectionSuite   "AI Mesh Selection Suite"

#define kAIMeshSelectionSuiteVersion   kAIMeshSelectionSuiteVersion3

#define kAIMeshSelectionSuiteVersion3   AIAPI_VERSION(3)

#define kAIMeshSelectionVersion   kAIMeshSelectionSuiteVersion

#define kAIMeshSuite   "AI Mesh Suite"

#define kAIMeshSuiteVersion   kAIMeshSuiteVersion6

#define kAIMeshSuiteVersion6   AIAPI_VERSION(6)

#define kAIMeshVersion   kAIMeshSuiteVersion

#define kAIMeshVertexIteratorSuite   "AI Mesh Vertex Suite"

#define kAIMeshVertexIteratorSuiteVersion   kAIMeshVertexIteratorSuiteVersion4

#define kAIMeshVertexIteratorSuiteVersion4   AIAPI_VERSION(4)

#define kAIMeshVertexIteratorVersion   kAIMeshVertexIteratorSuiteVersion

---

Typedef Documentation

typedef void(* AIMeshColorMap)(AIColor *color, void *userData)

Transformation function prototype for AIMeshSuite::MapColors() and AIMeshSelectionSuite::MapColors().

Parameters:

	color	The color to be transformed.
	userData	Developer-defined data passed through from the calling function.

typedef void(* AIMeshColorQuery)(AIColor *color, void *userData)

Color-query function prototype for AIMeshSuite::QueryColors() and AIMeshSelectionSuite::QueryColors().

Parameters:

	color	The color to be queried.
	userData	Developer-defined data passed through from the calling function.

typedef struct _AIMeshPatchIterator* AIMeshPatchIterator

Opaque reference to a mesh patch iterator.

See AIMeshPatchIteratorSuite

typedef void(* AIMeshPointMap)(AIRealPoint *point, void *userData)

Transformation function prototype for AIMeshSuite::MapPoints() and AIMeshSelectionSuite::MapPoints() The function is assumed to have a continuous first derivative.

Parameters:

	point	The point to be transformed.
	userData	Developer-defined data passed through from the calling function.

typedef struct _AIMeshSegmentIterator* AIMeshSegmentIterator

Opaque reference to a mesh segment iterator.

See AIMeshSegmentIteratorSuite

typedef struct _AIMeshSelection* AIMeshSelection

Opaque reference to a mesh selection.

See AIMeshSelectionSuite

typedef struct _AIMeshVertexIterator* AIMeshVertexIterator

Opaque reference to a mesh vertex iterator.

See AIMeshVertexIteratorSuite

---

Enumeration Type Documentation

enum AIMeshAxis

Node axes.

Enumerator:

kAIMeshIAxis	The I axis, containing integer values of nodes in a mesh.
kAIMeshJAxis	The J axis, containing integer values of nodes in a mesh.

enum AIMeshAxisSense

Directions along axes.

Enumerator:

kAIMeshAxisIncreasing
kAIMeshAxisDecreasing

enum AIMeshKind

Kinds of gradient mesh.

Enumerator:

kAICartesianMesh	Cartesian mesh.
kAIPolarMesh	Not implemented.

enum AIMeshPart

Parts of a mesh that can be hit.

Enumerator:

kAIMeshNowhere
kAIMeshVertex
kAIMeshTangent
kAIMeshEdge
kAIMeshPatch

enum AIMeshPatchDirection

Directions around patches.

Enumerator:

kAIMeshClockwise
kAIMeshCounterClockwise

enum AIMeshSelectionBoundsVariant

Variants for selection bounds.

Enumerator:

kAIMeshSelectionRigidBounds

Computes a bounding box of the parts of the mesh that transform rigidly when a selection is transformed. Excludes from the bounds those segments that are attached to a pair of vertices where one transforms and the other remains fixed.