Boks2D/io.github.joaomcl.boks2d.shapes/Shape

Shape

expect class Shape

A shape attached to a body. Shapes define the collision geometry and physical properties.

Properties

aabb

expect val aabb: AABB

Get the axis-aligned bounding box of this shape in world coordinates.

areContactEventsEnabled

expect val areContactEventsEnabled: Boolean

Are contact events enabled for this shape?

areHitEventsEnabled

expect val areHitEventsEnabled: Boolean

Are hit events enabled for this shape?

arePreSolveEventsEnabled

expect val arePreSolveEventsEnabled: Boolean

Are pre-solve events enabled for this shape?

areSensorEventsEnabled

expect val areSensorEventsEnabled: Boolean

Are sensor events enabled for this shape?

body

expect val body: Body

Get the body that this shape is attached to.

contactCount

expect val contactCount: Int

Get the contact capacity for this shape.

density

expect var density: Float

The density of this shape.

filter

expect var filter: Filter

The collision filter.

friction

expect var friction: Float

The friction of this shape.

isSensor

expect val isSensor: Boolean

Check if this shape is a sensor.

isValid

expect val isValid: Boolean

Check if this shape reference is valid. Shapes may be destroyed by the user or during world destruction.

material

expect var material: Int

The material identifier for this shape.

restitution

expect var restitution: Float

The restitution (bounciness) of this shape.

sensorCount

expect val sensorCount: Int

Get the sensor overlap capacity.

surfaceMaterial

expect var surfaceMaterial: SurfaceMaterial

The surface material properties.

type

expect val type: ShapeType

Get the type of this shape.

userData

expect var userData: Long

User data stored as a Long. Can be used as a key in a Map for associating arbitrary objects with this shape.

world

expect val world: World

Get the world that owns this shape.

Functions

destroy

expect fun destroy(updateBodyMass: Boolean = true)

Destroy this shape.

enableContactEvents

expect fun enableContactEvents(enabled: Boolean)

Enable or disable contact events for this shape.

enableHitEvents

expect fun enableHitEvents(enabled: Boolean)

Enable or disable hit events for this shape.

enablePreSolveEvents

expect fun enablePreSolveEvents(enabled: Boolean)

Enable or disable pre-solve events for this shape.

enableSensorEvents

expect fun enableSensorEvents(enabled: Boolean)

Enable or disable sensor events for this shape.

getCapsule

expect fun getCapsule(): Capsule

Get the capsule geometry. Only valid if type is Capsule.

getChainSegment

expect fun getChainSegment(): ChainSegment

Get the chain segment for this shape. Only valid if type is ChainSegment.

getCircle

expect fun getCircle(): Circle

Get the circle geometry. Only valid if type is Circle.

getClosestPoint

expect fun getClosestPoint(target: Vec2): Vec2

Get the closest point on this shape to the given target point.

getContactData

expect fun getContactData(): List<ContactData>

Get contact data for this shape.

getMassData

expect fun getMassData(): MassData

Get the mass data for this shape based on its geometry and density.

getParentChain

expect fun getParentChain(): Chain?

Get the parent chain for this shape, or null if not part of a chain.

getPolygon

expect fun getPolygon(): Polygon

Get the polygon geometry. Only valid if type is Polygon.

getSegment

expect fun getSegment(): Segment

Get the segment geometry. Only valid if type is Segment.

getSensorOverlaps

expect fun getSensorOverlaps(): List<Shape>

Get the shapes overlapping with this sensor. Only valid for sensors.

rayCast

expect fun rayCast(origin: Vec2, translation: Vec2): CastOutput

Cast a ray against this shape.

setCapsule

expect fun setCapsule(capsule: Capsule)

Set the capsule geometry. Only valid if type is Capsule.

setCircle

expect fun setCircle(circle: Circle)

Set the circle geometry. Only valid if type is Circle.

setDensity

expect fun setDensity(density: Float, updateBodyMass: Boolean = true)

Set the density with control over body mass update.

setPolygon

expect fun setPolygon(polygon: Polygon)

Set the polygon geometry. Only valid if type is Polygon.

setSegment

expect fun setSegment(segment: Segment)

Set the segment geometry. Only valid if type is Segment.

testPoint

expect fun testPoint(point: Vec2): Boolean

Test a point for overlap with this shape.