AIHitTest.h File Reference

#include "AIPluginGroup.h"
#include "AITool.h"
#include "AIHeaderBegin.h"
#include "AIHeaderEnd.h"

Go to the source code of this file.

Classes
struct	AIToolHitData
	Returned by AIHitTestSuite::GetHitData(), describes the results of a hit test. More...
struct	AIHitTestSuite
	These function allow you to query a document or art subtree for objects based on positional information. More...
Defines
#define	kAIHitTestSuite   "AI Hit Test Suite"
#define	kAIHitTestSuiteVersion19   AIAPI_VERSION(7)
#define	kAIHitTestSuiteVersion   kAIHitTestSuiteVersion19
#define	kAIHitTestVersion   kAIHitTestSuiteVersion
Typedefs
typedef struct AIHit *	AIHitRef
	A hit object, which describes what was found by AIHitTestSuite functions at a specified point.
Enumerations
enum	AIHitType {   kPHitType, kInHitType, kOutHitType, kSegmentHitType,   kFillHitType, kCenterHitType, kTwoGuideHitType }
	Hit types for objects found by hit requests. More...
enum	AIHitRequest {   kAllHitRequest, kPHitRequest, kEndPHitRequest, kGuideHitRequest,   kNearestPointOnPathHitRequest, kTextHitRequest, kSelectedObjectHitRequest, kPaintHitRequest,   kAllNoFillHitRequest, kPaintNoFillHitRequest, kNoControlHandlesHitRequest, kNoLockedPaintHitRequest,   kAllPHitRequest, kAllHitPreviewRequest, kStrokeHitRequest }
	Hit requests specify what types of hits to look for and report as a hit. More...

---

Detailed Description

---

Define Documentation

#define kAIHitTestSuite   "AI Hit Test Suite"

#define kAIHitTestSuiteVersion   kAIHitTestSuiteVersion19

#define kAIHitTestSuiteVersion19   AIAPI_VERSION(7)

#define kAIHitTestVersion   kAIHitTestSuiteVersion

---

Typedef Documentation

typedef struct AIHit* AIHitRef

A hit object, which describes what was found by AIHitTestSuite functions at a specified point.

Contains both generic information that applies to all objects and some information specific to the object type. For example, it always identifies the object if one was found. If the object is a path, there is additional information about the part of the path that was hit. See specific suites, such as AIMeshHitSuite, to extract additional object-specific information.

---

Enumeration Type Documentation

enum AIHitRequest

Hit requests specify what types of hits to look for and report as a hit.

Enumerator:

kAllHitRequest	Report any object hits anywhere.
kPHitRequest	Report only hits on anchor points of beziers.
kEndPHitRequest	Report only first or last bezier point hits on path.
kGuideHitRequest	Report only hits on guide object.
kNearestPointOnPathHitRequest	Report only hits on points on paths or any guides.
kTextHitRequest	Report only hits on text objects.
kSelectedObjectHitRequest	Report only hits on already-selected objects.
kPaintHitRequest	Report hits on paintable objects (non-guide paths & text).
kAllNoFillHitRequest	Report all hits, but does not test against object fills.
kPaintNoFillHitRequest	Report hits on paintable objects (non-guide paths & text), but does not test against object fills.
kNoControlHandlesHitRequest	Report all hits, but does not text against direction line endpoints (the in and out handles of a bezier).
kNoLockedPaintHitRequest	Report hits on paintable objects (non-guide paths & text), but does not test locked objects.
kAllPHitRequest	Report only hits on anchor points of beziers and on direction handle points of paths.
kAllHitPreviewRequest	Same as kAllHitRequest, except that the search always checks both points and fills of the object, regardless of a document's view mode.
kStrokeHitRequest	Report only hits on (focal) strokes of paths. The hit tolerance is interpreted as being a distance from the stroked area instead of a distance from the bezier. The AIHitType will be returned as either kSegmentHitType or kPHitType, depending on the nearest point on the path.

enum AIHitType

Hit types for objects found by hit requests.

See AIHitTestSuite::GetType() and AIHitTestSuite::GetSubType()

Enumerator:

kPHitType	Hit an anchor point.
kInHitType	Hit a leading direction line endpoint.
kOutHitType	Hit a trailing direction line endpoint.
kSegmentHitType	Hit a segment interior.
kFillHitType	Hit generated by infill during preview mode.
kCenterHitType	Hit the center point of an object with show center point on.
kTwoGuideHitType	Hit the intersection of two guides.