Struct gdnative::api::CapsuleShape2D

pub struct CapsuleShape2D { /* fields omitted */ }

core class CapsuleShape2D inherits Shape2D (reference counted).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

CapsuleShape2D inherits methods from:

• Shape2D
• Resource
• Reference
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl CapsuleShape2D

pub fn new() -> Ref<CapsuleShape2D, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn height(&self) -> f64

The capsule's height.

pub fn radius(&self) -> f64

The capsule's radius.

pub fn set_height(&self, height: f64)

The capsule's height.

pub fn set_radius(&self, radius: f64)

The capsule's radius.

Methods from Deref<Target = Shape2D>

pub fn collide(
    &self,
    local_xform: Transform2D<f32, UnknownUnit, UnknownUnit>,
    with_shape: impl AsArg<Shape2D>,
    shape_xform: Transform2D<f32, UnknownUnit, UnknownUnit>
) -> bool

Returns [code]true[/code] if this shape is colliding with another.
				This method needs the transformation matrix for this shape ([code]local_xform[/code]), the shape to check collisions with ([code]with_shape[/code]), and the transformation matrix of that shape ([code]shape_xform[/code]).

pub fn collide_and_get_contacts(
    &self,
    local_xform: Transform2D<f32, UnknownUnit, UnknownUnit>,
    with_shape: impl AsArg<Shape2D>,
    shape_xform: Transform2D<f32, UnknownUnit, UnknownUnit>
) -> VariantArray<Shared>

Returns a list of the points where this shape touches another. If there are no collisions the list is empty.
				This method needs the transformation matrix for this shape ([code]local_xform[/code]), the shape to check collisions with ([code]with_shape[/code]), and the transformation matrix of that shape ([code]shape_xform[/code]).

pub fn collide_with_motion(
    &self,
    local_xform: Transform2D<f32, UnknownUnit, UnknownUnit>,
    local_motion: Vector2D<f32, UnknownUnit>,
    with_shape: impl AsArg<Shape2D>,
    shape_xform: Transform2D<f32, UnknownUnit, UnknownUnit>,
    shape_motion: Vector2D<f32, UnknownUnit>
) -> bool

Returns whether this shape would collide with another, if a given movement was applied.
				This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test onto the other object ([code]shape_motion[/code]).

pub fn collide_with_motion_and_get_contacts(
    &self,
    local_xform: Transform2D<f32, UnknownUnit, UnknownUnit>,
    local_motion: Vector2D<f32, UnknownUnit>,
    with_shape: impl AsArg<Shape2D>,
    shape_xform: Transform2D<f32, UnknownUnit, UnknownUnit>,
    shape_motion: Vector2D<f32, UnknownUnit>
) -> VariantArray<Shared>

Returns a list of the points where this shape would touch another, if a given movement was applied. If there are no collisions the list is empty.
				This method needs the transformation matrix for this shape ([code]local_xform[/code]), the movement to test on this shape ([code]local_motion[/code]), the shape to check collisions with ([code]with_shape[/code]), the transformation matrix of that shape ([code]shape_xform[/code]), and the movement to test onto the other object ([code]shape_motion[/code]).

pub fn draw(&self, canvas_item: Rid, color: Color)

Draws a solid shape onto a [CanvasItem] with the [VisualServer] API filled with the specified [code]color[/code]. The exact drawing method is specific for each shape and cannot be configured.

pub fn custom_solver_bias(&self) -> f64

The shape's custom solver bias.

pub fn set_custom_solver_bias(&self, bias: f64)

The shape's custom solver bias.

Trait Implementations

impl Debug for CapsuleShape2D

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for CapsuleShape2D

type Target = Shape2D

The resulting type after dereferencing.

fn deref(&self) -> &Shape2D

Dereferences the value.

impl DerefMut for CapsuleShape2D

fn deref_mut(&mut self) -> &mut Shape2D

Mutably dereferences the value.

impl GodotObject for CapsuleShape2D

type RefKind = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for CapsuleShape2D

fn construct() -> Ref<CapsuleShape2D, Unique>

impl SubClass<Object> for CapsuleShape2D

impl SubClass<Reference> for CapsuleShape2D

impl SubClass<Resource> for CapsuleShape2D

impl SubClass<Shape2D> for CapsuleShape2D