Point Containment Test Functions

Collection of functions testing for a point's containment within various objects. More...

Functions
bool	TestPoint (const DistanceProxy &proxy, const Length2 &point) noexcept
	Tests a point for containment in the given distance proxy. More...
bool	playrho::d2::TestPoint (const DistanceProxy &proxy, const Length2 &point) noexcept
	Tests a point for containment in the given distance proxy. More...
bool	TestPoint (const Shape &shape, const Length2 &point) noexcept
	Test a point for containment in the given shape. More...
bool	playrho::d2::TestPoint (const Shape &shape, const Length2 &point) noexcept
	Test a point for containment in the given shape. More...
bool	TestPoint (const World &world, BodyID bodyId, ShapeID shapeId, const Length2 &p)
	Tests a point for containment in a shape associated with a body. More...
bool	playrho::d2::TestPoint (const World &world, BodyID bodyId, ShapeID shapeId, const Length2 &p)
	Tests a point for containment in a shape associated with a body. More...

Detailed Description

Collection of functions testing for a point's containment within various objects.

Function Documentation

TestPoint() [1/6]

bool TestPoint ( const DistanceProxy &  proxy, const Length2 &  point  )

related

Tests a point for containment in the given distance proxy.

Parameters

proxy	Distance proxy to check if point is within.
point	Point in local coordinates.

Returns

true if point is contained in proxy, false otherwise.

TestPoint() [2/6]

bool playrho::d2::TestPoint ( const DistanceProxy &  proxy, const Length2 &  point  )

noexcept

Tests a point for containment in the given distance proxy.

Parameters

proxy	Distance proxy to check if point is within.
point	Point in local coordinates.

Returns

true if point is contained in proxy, false otherwise.

Examples

WorldShape.cpp.

Referenced by playrho::d2::Shape::TestPoint(), and playrho::d2::World::TestPoint().

TestPoint() [3/6]

bool TestPoint ( const Shape &  shape, const Length2 &  point  )

related

Test a point for containment in the given shape.

Parameters

shape	Shape to use for test.
point	Point in local coordinates.

Returns

true if the given point is contained by the given shape, false otherwise.

TestPoint() [4/6]

bool playrho::d2::TestPoint ( const Shape &  shape, const Length2 &  point  )

noexcept

Test a point for containment in the given shape.

Parameters

shape	Shape to use for test.
point	Point in local coordinates.

Returns

true if the given point is contained by the given shape, false otherwise.

TestPoint() [5/6]

bool TestPoint ( const World &  world, BodyID  bodyId, ShapeID  shapeId, const Length2 &  p  )

related

Tests a point for containment in a shape associated with a body.

Parameters

world	The world that the given shape ID exists within.
bodyId	Body to use for test.
shapeId	Shape to use for test.
p	Point in world coordinates.

Exceptions

std::out_of_range

If given an invalid body or shape identifier.

TestPoint() [6/6]

bool playrho::d2::TestPoint	(	const World &	world,
		BodyID	bodyId,
		ShapeID	shapeId,
		const Length2 &	p
	)

Tests a point for containment in a shape associated with a body.

Parameters

world	The world that the given shape ID exists within.
bodyId	Body to use for test.
shapeId	Shape to use for test.
p	Point in world coordinates.

Exceptions

std::out_of_range

If given an invalid body or shape identifier.