AIToolHitData Struct Reference

Returned by AIHitTestSuite::GetHitData(), describes the results of a hit test. More...

#include <AIHitTest.h>

List of all members.

Public Member Functions
	AIToolHitData ()
Public Attributes
AIBoolean	hit
	True if the test found an object matching test criteria.
ai::int16	type
	The AIHitType value for the found object.
ai::int16	subType
	The AIHitType value for the subtype when the type of the found object is kFillHitType.
ai::int16	segment
	If the hit is on an anchor point or segment of a path, the path segment number.
AIArtHandle	object
	The leaf art object that matched the test criteria.
AIArtHandle	group
	The group containing the leaf art object.
AIRealPoint	point
	The exact point location of the hit, after snapping to anchor points, bezier edges, etc.
AIReal	t
	If the hit was on a segment of a path, the parametric value of the nearest location on the segment to the hit.

---

Detailed Description

Returned by AIHitTestSuite::GetHitData(), describes the results of a hit test.

The same information can be obtained by individual APIs in the AIHitTestSuite.

---

Constructor & Destructor Documentation

AIToolHitData::AIToolHitData

(

)

[inline]

---

Member Data Documentation

AIArtHandle AIToolHitData::group

The group containing the leaf art object.

See AIHitTestSuite::GetGroup()

AIBoolean AIToolHitData::hit

True if the test found an object matching test criteria.

See AIHitTestSuite::IsHit()

AIArtHandle AIToolHitData::object

The leaf art object that matched the test criteria.

See AIHitTestSuite::GetArt()

AIRealPoint AIToolHitData::point

The exact point location of the hit, after snapping to anchor points, bezier edges, etc.

See AIHitTestSuite::GetPoint()

ai::int16 AIToolHitData::segment

If the hit is on an anchor point or segment of a path, the path segment number.

See AIHitTestSuite::GetPathSegment()

ai::int16 AIToolHitData::subType

The AIHitType value for the subtype when the type of the found object is kFillHitType.

See AIHitTestSuite::GetSubType()

AIReal AIToolHitData::t

If the hit was on a segment of a path, the parametric value of the nearest location on the segment to the hit.

See AIHitTestSuite::GetPathParameter()

ai::int16 AIToolHitData::type

The AIHitType value for the found object.

See AIHitTestSuite::GetType()

---

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

• AIHitTest.h