Point Containment Test Functions

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

Functions
bool	playrho::d2::TestPoint (const DistanceProxy &proxy, Length2 point) noexcept
	Tests a point for containment in the given distance proxy. More...
bool	playrho::d2::TestPoint (const Shape &shape, Length2 point) noexcept
	Test a point for containment in the given shape. More...
bool	playrho::d2::TestPoint (const World &world, FixtureID id, Length2 p)
	Tests a point for containment in a fixture. More...
bool	TestPoint (const DistanceProxy &proxy, Length2 point) noexcept
	Tests a point for containment in the given distance proxy. More...
bool	TestPoint (const Shape &shape, Length2 point) noexcept
	Test a point for containment in the given shape. More...
bool	TestPoint (const World &world, FixtureID id, Length2 p)
	Tests a point for containment in a fixture. 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, 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 the proxy, false otherwise.

Examples

WorldFixture.cpp.

Referenced by playrho::d2::TestPoint().

TestPoint() [2/6]

bool TestPoint ( const DistanceProxy &  proxy, 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 the proxy, false otherwise.

TestPoint() [3/6]

bool TestPoint ( const Shape &  shape, 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() [4/6]

bool TestPoint ( const Shape &  shape, 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() [5/6]

bool TestPoint	(	const World &	world,
		FixtureID	id,
		Length2	p
	)

Tests a point for containment in a fixture.

Parameters

world	The world that the given fixture ID exists within.
id	Fixture to use for test.
p	Point in world coordinates.

Exceptions

std::out_of_range

If given an invalid fixture identifier.

TestPoint() [6/6]

bool TestPoint ( const World &  world, FixtureID  id, Length2  p  )

related

Tests a point for containment in a fixture.

Parameters

world	The world that the given fixture ID exists within.
id	Fixture to use for test.
p	Point in world coordinates.

Exceptions

std::out_of_range

If given an invalid fixture identifier.