HughPH.Box2D
Organised dotnet bindings for Box2D 3.1.1
Loading...
Searching...
No Matches
Public Member Functions | Properties | List of all members
Box2D.ChainShape Class Reference

A chain shape is a series of connected line segments. More...

Inherits IEquatable< ChainShape >, and IComparable< ChainShape >.

Public Member Functions

unsafe void Destroy ()
 Destroys this chain shape.
 
bool Equals (ChainShape other)
 Checks equality between two ChainShape values.
 
override bool Equals (object? obj)
 
override int GetHashCode ()
 
int CompareTo (ChainShape other)
 Compares this instance to another ChainShape.
 

Properties

unsafe World World [get]
 Gets the world that owns this chain shape.
 
unsafe ReadOnlySpan< ShapeSegments [get]
 The chain segments.
 
unsafe float Friction [get, set]
 The chain friction.
 
unsafe float Restitution [get, set]
 The chain restitution (bounciness)
 
unsafe int Material [get, set]
 The chain material.
 
unsafe bool Valid [get]
 Checks if the chain shape is valid.
 
static IEqualityComparer< ChainShapeDefaultEqualityComparer = ChainShapeComparer.Instance [get]
 Default equality comparer for ChainShape.
 
static IComparer< ChainShapeDefaultComparer = ChainShapeComparer.Instance [get]
 Default comparer for ChainShape.
 

Detailed Description

A chain shape is a series of connected line segments.

Member Function Documentation

◆ Destroy()

unsafe void Box2D.ChainShape.Destroy ( )
inline

Destroys this chain shape.

This will remove the chain shape from the world and destroy all contacts associated with this shape

Property Documentation

◆ Valid

unsafe bool Box2D.ChainShape.Valid
get

Checks if the chain shape is valid.

Returns
True if the chain shape is valid, false otherwise

◆ World

unsafe World Box2D.ChainShape.World
get

Gets the world that owns this chain shape.

Returns
The world that owns this chain shape

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