Module technology.sola.engine

Package technology.sola.engine.physics.component.collider

Record Class ColliderShapeConvexPolygon

java.lang.Object

java.lang.Record

technology.sola.engine.physics.component.collider.ColliderShapeConvexPolygon

Record Components:

shape - the convex polygon shape of this collider

All Implemented Interfaces:

ColliderShape<ConvexPolygon>

@NullMarked
public record ColliderShapeConvexPolygon(ConvexPolygon shape)
extends Record
implements ColliderShape<ConvexPolygon>

ColliderShapeConvexPolygon is a ColliderShape implementation for a convex polygon which utilize a ConvexPolygon for its geometric shape representation.

Constructor Summary

Constructors

Constructor	Description
ColliderShapeConvexPolygon(ConvexPolygon shape)	Creates an instance of a ColliderShapeConvexPolygon record class.

Method Summary

Modifier and Type	Method	Description
void	debugRender(Renderer renderer, TransformComponent transformComponent, float offsetX, float offsetY)	Renders debug information for the collider shape.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Rectangle	getBoundingBox(TransformComponent transformComponent, float offsetX, float offsetY)	Returns the bounding box for this ColliderShape.
ConvexPolygon	getShape(TransformComponent transformComponent, float offsetX, float offsetY)	Gets the geometric Shape for this collider shape.
final int	hashCode()	Returns a hash code value for this object.
ConvexPolygon	shape()	Returns the value of the shape record component.
final String	toString()	Returns a string representation of this record class.
ColliderType	type()	Gets the ColliderType of this collider.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ColliderShapeConvexPolygon

public ColliderShapeConvexPolygon(ConvexPolygon shape)

Creates an instance of a ColliderShapeConvexPolygon record class.

Parameters:

shape - the value for the shape record component

Method Details

type

public ColliderType type()

Description copied from interface: ColliderShape

Gets the ColliderType of this collider.

Specified by:

type in interface ColliderShape<ConvexPolygon>

Returns:

the ColliderType of this collider

getBoundingBox

public Rectangle getBoundingBox(TransformComponent transformComponent,
 float offsetX,
 float offsetY)

Description copied from interface: ColliderShape

Returns the bounding box for this ColliderShape.

Specified by:

getBoundingBox in interface ColliderShape<ConvexPolygon>

Parameters:

transformComponent - the TransformComponent of the entity

offsetX - the x offset of the collider

offsetY - the y offset of the collider

Returns:

the bounding box

getShape

public ConvexPolygon getShape(TransformComponent transformComponent,
 float offsetX,
 float offsetY)

Description copied from interface: ColliderShape

Gets the geometric Shape for this collider shape.

Specified by:

getShape in interface ColliderShape<ConvexPolygon>

Parameters:

transformComponent - the TransformComponent for the Entity

offsetX - the x offset off the collider

offsetY - the y offset of the collider

Returns:

the geometric Shape

debugRender

public void debugRender(Renderer renderer,
 TransformComponent transformComponent,
 float offsetX,
 float offsetY)

Description copied from interface: ColliderShape

Renders debug information for the collider shape.

Specified by:

debugRender in interface ColliderShape<ConvexPolygon>

Parameters:

renderer - the Renderer

transformComponent - the Entity's TransformComponent

offsetX - the collider shape x-axis offset

offsetY - the collider shape y-axis offset

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

shape

public ConvexPolygon shape()

Returns the value of the shape record component.

Returns:

the value of the shape record component