#include <Shape.hpp>

Public Member Functions
	Shape ()
	Default constructor. More...

template<typename T >
	Shape (T arg)
	Initializing constructor. More...

	Shape (const Shape &other)=default
	Copy constructor. More...

	Shape (Shape &&other)=default
	Move constructor. More...

Shape &	operator= (const Shape &other)=default
	Copy assignment operator. More...

Shape &	operator= (Shape &&other)=default
	Move assignment operator. More...

Friends
ChildCounter	GetChildCount (const Shape &shape) noexcept
	Gets the number of child primitives of the shape. More...

DistanceProxy	GetChild (const Shape &shape, ChildCounter index)
	Gets the "child" for the given index. More...

MassData	GetMassData (const Shape &shape) noexcept
	Gets the mass properties of this shape using its dimensions and density. More...

NonNegative< Length >	GetVertexRadius (const Shape &shape, ChildCounter idx)
	Gets the vertex radius of the indexed child of the given shape. More...

Real	GetFriction (const Shape &shape) noexcept
	Gets the coefficient of friction. More...

Real	GetRestitution (const Shape &shape) noexcept
	Gets the coefficient of restitution value of the given shape. More...

NonNegative< AreaDensity >	GetDensity (const Shape &shape) noexcept
	Gets the density of the given shape. More...

void	Transform (Shape &shape, const Mat22 &m)
	Transforms all of the given shape's vertices by the given transformation matrix. More...

bool	Visit (const Shape &shape, void *userData)
	Visits the given shape with the potentially non-null user data pointer. More...

const friend void *	GetData (const Shape &shape) noexcept
	Gets a pointer to the underlying data. More...

const friend std::type_info &	GetUseTypeInfo (const Shape &shape)
	Gets the type info of the use of the given shape. More...

void	Accept (const Shape &shape, const TypeInfoVisitor &visitor)
	Accepts a visitor. More...

bool	operator== (const Shape &lhs, const Shape &rhs) noexcept
	Equality operator for shape to shape comparisons. More...

bool	operator!= (const Shape &lhs, const Shape &rhs) noexcept
	Inequality operator for shape to shape comparisons. More...

Related Functions
(Note that these are not member functions.)
AABB	ComputeAABB (const Shape &shape, const Transformation &xf) noexcept
	Computes the AABB for the given shape with the given transformation. More...

RayCastOutput	RayCast (const Shape &shape, ChildCounter childIndex, const RayCastInput &input, const Transformation &transform) noexcept
	Cast a ray against the child of the given shape. More...

bool	TestPoint (const Shape &shape, Length2 point) noexcept
	Test a point for containment in the given shape. More...

Detailed Description

Shape.

A shape is used for collision detection. You can create a shape from any supporting type. Shapes are conceptually made up of zero or more convex child shapes where each child shape is made up of zero or more vertices and an associated radius called its "vertex radius".

Note: This class implements polymorphism without inheritance. This is based on a technique that's described by Sean Parent in his January 2017 Norwegian Developers Conference London talk "Better Code: Runtime Polymorphism". With this implementation, different shapes types can be had by constructing instances of this class with the different types that provide the required support. Different shapes of a given type meanwhile are had by providing different values for the type.; This data structure is 32-bytes large (on at least one 64-bit platform).

See also: Fixture; https://youtu.be/QGcVXgEVMJg

Examples: Body.cpp, Contact.cpp, HelloWorld.cpp, and World.cpp.

Definition at line 162 of file Shape.hpp.

Constructor & Destructor Documentation

◆ Shape() [1/4]

playrho::d2::Shape::Shape ( )

Default constructor.

Exceptions

std::bad_alloc if there's a failure allocating storage.

Definition at line 79 of file Shape.cpp.

◆ Shape() [2/4]

template<typename T >

playrho::d2::Shape::Shape ( T arg )

inlineexplicit

Initializing constructor.

Parameters

arg	Configuration value to construct a shape instance for.

Note: Only usable with types of values that have all of the support functions required by this class. The compiler emits errors if the given type doesn't.

See also: GetChildCount; GetChild; GetMassData; GetVertexRadius; GetDensity; GetFriction; GetRestitution

Exceptions

std::bad_alloc if there's a failure allocating storage.

Definition at line 182 of file Shape.hpp.

◆ Shape() [3/4]

playrho::d2::Shape::Shape ( const Shape & other )

default

Copy constructor.

◆ Shape() [4/4]

playrho::d2::Shape::Shape ( Shape && other )

default

Move constructor.

Member Function Documentation

◆ operator=() [1/2]

Shape& playrho::d2::Shape::operator= ( const Shape & other )

default

Copy assignment operator.

◆ operator=() [2/2]

Shape& playrho::d2::Shape::operator= ( Shape && other )

default

Move assignment operator.

Friends And Related Function Documentation

◆ GetChildCount

ChildCounter GetChildCount ( const Shape & shape )

friend

Gets the number of child primitives of the shape.

Returns: Non-negative count.

Definition at line 199 of file Shape.hpp.

◆ GetChild

DistanceProxy GetChild	(	const Shape &	shape,
		ChildCounter	index
	)

friend

Gets the "child" for the given index.

Parameters

shape	Shape to get "child" shape of.
index	Index to a child element of the shape. Value must be less than the number of child primitives of the shape.

Note: The shape must remain in scope while the proxy is in use.

Exceptions

InvalidArgument if the given index is out of range.

See also: GetChildCount

Definition at line 204 of file Shape.hpp.

◆ GetMassData

MassData GetMassData ( const Shape & shape )

friend

Gets the mass properties of this shape using its dimensions and density.

Returns: Mass data for this shape.

Definition at line 209 of file Shape.hpp.

◆ GetVertexRadius

NonNegative<Length> GetVertexRadius	(	const Shape &	shape,
		ChildCounter	idx
	)

friend

Gets the vertex radius of the indexed child of the given shape.

This gets the radius from the vertex that the shape's "skin" should extend outward by. While any edges - line segments between multiple vertices - are straight, corners between them (the vertices) are rounded and treated as rounded. Shapes with larger vertex radiuses compared to edge lengths therefore will be more prone to rolling or having other shapes more prone to roll off of them. Here's an image of a shape configured via a PolygonShapeConf with it's skin drawn:

Parameters

shape	Shape to get child's vertex radius for.
idx	Child index to get vertex radius for.

Note: This must be a non-negative value.

See also: UseVertexRadius

Exceptions

InvalidArgument if the child index is not less than the child count.

Definition at line 214 of file Shape.hpp.

◆ GetFriction

Real GetFriction ( const Shape & shape )

friend

Gets the coefficient of friction.

Returns: Value of 0 or higher.

Definition at line 219 of file Shape.hpp.

◆ GetRestitution

Real GetRestitution ( const Shape & shape )

friend

Gets the coefficient of restitution value of the given shape.

Definition at line 224 of file Shape.hpp.

◆ GetDensity

NonNegative<AreaDensity> GetDensity ( const Shape & shape )

friend

Gets the density of the given shape.

Returns: Non-negative density (in mass per area).

Definition at line 229 of file Shape.hpp.

◆ Transform

void Transform	(	Shape &	shape,
		const Mat22 &	m
	)

friend

Transforms all of the given shape's vertices by the given transformation matrix.

See also: https://en.wikipedia.org/wiki/Transformation_matrix

Note: This may throw std::bad_alloc or any exception that's thrown by the constructor for the model's underlying data type.

Exceptions

std::bad_alloc if there's a failure allocating storage.

Definition at line 234 of file Shape.hpp.

◆ Visit

bool Visit	(	const Shape &	shape,
		void *	userData
	)

friend

Visits the given shape with the potentially non-null user data pointer.

See also: https://en.wikipedia.org/wiki/Visitor_pattern

Definition at line 241 of file Shape.hpp.

◆ GetData

const friend void* GetData ( const Shape & shape )

friend

Gets a pointer to the underlying data.

Note: Provided for introspective purposes like visitation.; Generally speaking, try to avoid using this method unless there's no other way to access the underlying data.

Definition at line 246 of file Shape.hpp.

◆ GetUseTypeInfo

const friend std::type_info& GetUseTypeInfo ( const Shape & shape )

friend

Gets the type info of the use of the given shape.

Note: This is not the same as calling typeid(Shape).

Returns: Type info of the underlying value's type.

Definition at line 251 of file Shape.hpp.

◆ Accept

void Accept	(	const Shape &	shape,
		const TypeInfoVisitor &	visitor
	)

friend

Accepts a visitor.

This is the "accept" method definition of a "visitor design pattern" for doing shape configuration specific types of processing for a constant shape.

See also: https://en.wikipedia.org/wiki/Visitor_pattern

Definition at line 256 of file Shape.hpp.

◆ operator==

bool operator==	(	const Shape &	lhs,
		const Shape &	rhs
	)

friend

Equality operator for shape to shape comparisons.

Definition at line 262 of file Shape.hpp.

◆ operator!=

bool operator!=	(	const Shape &	lhs,
		const Shape &	rhs
	)

friend

Inequality operator for shape to shape comparisons.

Definition at line 267 of file Shape.hpp.

◆ ComputeAABB()

AABB ComputeAABB	(	const Shape &	shape,
		const Transformation &	xf
	)

Definition at line 61 of file AABB.cpp.

The documentation for this class was generated from the following files:

Collision/Shapes/Shape.hpp
Collision/AABB.hpp
Collision/RayCastOutput.hpp
Collision/Shapes/Shape.cpp

Public Member Functions

Friends

Related Functions

Detailed Description

Constructor & Destructor Documentation

◆ Shape() [1/4]

◆ Shape() [2/4]

◆ Shape() [3/4]

◆ Shape() [4/4]

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

Friends And Related Function Documentation

◆ GetChildCount

◆ GetChild

◆ GetMassData

◆ GetVertexRadius

◆ GetFriction

◆ GetRestitution

◆ GetDensity

◆ Transform

◆ Visit

◆ GetData

◆ GetUseTypeInfo

◆ Accept

◆ operator==

◆ operator!=

◆ ComputeAABB()