HughPH.Box2D
Organised dotnet bindings for Box2D 3.1.0
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Properties | List of all members
Box2D.ShapeCastInput Struct Reference

Low level shape cast input in generic form. This allows casting an arbitrary point cloud wrap with a radius. For example, a circle is a single point with a non-zero radius. A capsule is two points with a non-zero radius. A box is four points with a zero radius. More...

Collaboration diagram for Box2D.ShapeCastInput:
Collaboration graph
[legend]

Public Member Functions

 ShapeCastInput (ShapeProxy proxy, Vec2 translation, float maxFraction, bool canEncroach)
 Constructs a new ShapeCastInput object with the given parameters.
 
 ShapeCastInput ()
 Constructs a new ShapeCastInput object with default values.
 

Public Attributes

ShapeProxy Proxy
 A generic shape.
 
Vec2 Translation
 The translation of the shape cast.
 
float MaxFraction
 The maximum fraction of the translation to consider, typically 1.
 

Properties

bool CanEncroach [get, set]
 Allow shape cast to encroach when initially touching. This only works if the radius is greater than zero.
 

Detailed Description

Low level shape cast input in generic form. This allows casting an arbitrary point cloud wrap with a radius. For example, a circle is a single point with a non-zero radius. A capsule is two points with a non-zero radius. A box is four points with a zero radius.

Constructor & Destructor Documentation

◆ ShapeCastInput()

Box2D.ShapeCastInput.ShapeCastInput ( ShapeProxy  proxy,
Vec2  translation,
float  maxFraction,
bool  canEncroach 
)
inline

Constructs a new ShapeCastInput object with the given parameters.

Parameters
proxyA generic shape
translationThe translation of the shape cast
maxFractionThe maximum fraction of the translation to consider, typically 1
canEncroachAllow shape cast to encroach when initially touching. This only works if the radius is greater than zero.

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