Used to create a chain of line segments. This is designed to eliminate ghost collisions with some limitations. More...

Public Member Functions
	ChainDef ()
	Creates a chain definition with the default values.

unsafe	ChainDef (ReadOnlySpan< Vec2 > points, bool autoGenerateGhostVertices=false)
	Creates a chain definition with the supplied points.

Properties
object?	UserData `[get, set]`
	Use this to store application specific shape data.

unsafe ReadOnlySpan< Vec2 >	Points `[get, set]`
	An array of at least 4 points. These are cloned and may be temporary.

unsafe ReadOnlySpan< SurfaceMaterial >	Materials `[get, set]`
	Surface materials for each segment. These are cloned.

ref Filter	Filter `[get]`
	Contact filtering data.

bool	IsLoop `[get, set]`
	Indicates a closed chain formed by connecting the first and last points.

bool	EnableSensorEvents `[get, set]`
	Enable sensors to detect this chain. False by default.

Detailed Description

Used to create a chain of line segments. This is designed to eliminate ghost collisions with some limitations.

chains are one-sided
chains have no mass and should be used on static bodies
chains have a counter-clockwise winding order
chains are either a loop or open
a chain must have at least 4 points
the distance between any two points must be greater than B2_LINEAR_SLOP
a chain shape should not self intersect (this is not validated)
an open chain shape has NO COLLISION on the first and final edge
you may overlap two open chains on their first three and/or last three points to get smooth collision
a chain shape creates multiple line segment shapes on the body

https://en.wikipedia.org/wiki/Polygonal_chain
Warning: Do not use chain shapes unless you understand the limitations. This is an advanced feature.

Constructor & Destructor Documentation

unsafe Box2D.ChainDef.ChainDef	(	ReadOnlySpan< Vec2 >	points,
		bool	autoGenerateGhostVertices = `false`
	)

inline

Creates a chain definition with the supplied points.

Parameters

points	The points to create the chain from
autoGenerateGhostVertices	If true, additional first and last points will be generated automatically. Has no effect when IsLoop is true.

unsafe ReadOnlySpan<Vec2> Box2D.ChainDef.Points

getset

An array of at least 4 points. These are cloned and may be temporary.

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