Struct gdnative::api::CollisionObject

pub struct CollisionObject { /* fields omitted */ }

core class CollisionObject inherits Spatial (unsafe).

Official documentation

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

Class hierarchy

CollisionObject inherits methods from:

• Spatial
• Node
• 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 CollisionObject

pub fn create_shape_owner(&self, owner: impl AsArg<Object>) -> i64

pub fn capture_input_on_drag(&self) -> bool

pub fn get_rid(&self) -> Rid

pub fn get_shape_owners(&self) -> VariantArray<Shared>

pub fn is_ray_pickable(&self) -> bool

pub fn is_shape_owner_disabled(&self, owner_id: i64) -> bool

pub fn remove_shape_owner(&self, owner_id: i64)

pub fn set_capture_input_on_drag(&self, enable: bool)

pub fn set_ray_pickable(&self, ray_pickable: bool)

pub fn shape_find_owner(&self, shape_index: i64) -> i64

pub fn shape_owner_add_shape(&self, owner_id: i64, shape: impl AsArg<Shape>)

pub fn shape_owner_clear_shapes(&self, owner_id: i64)

pub fn shape_owner_get_owner(
    &self,
    owner_id: i64
) -> Option<Ref<Object, Shared>>

pub fn shape_owner_get_shape(
    &self,
    owner_id: i64,
    shape_id: i64
) -> Option<Ref<Shape, Shared>>

pub fn shape_owner_get_shape_count(&self, owner_id: i64) -> i64

pub fn shape_owner_get_shape_index(&self, owner_id: i64, shape_id: i64) -> i64

pub fn shape_owner_get_transform(&self, owner_id: i64) -> Transform

pub fn shape_owner_remove_shape(&self, owner_id: i64, shape_id: i64)

pub fn shape_owner_set_disabled(&self, owner_id: i64, disabled: bool)

pub fn shape_owner_set_transform(&self, owner_id: i64, transform: Transform)

Methods from Deref<Target = Spatial>

pub const NOTIFICATION_ENTER_WORLD: i64

pub const NOTIFICATION_EXIT_WORLD: i64

pub const NOTIFICATION_TRANSFORM_CHANGED: i64

pub const NOTIFICATION_VISIBILITY_CHANGED: i64

pub fn force_update_transform(&self)

pub fn gizmo(&self) -> Option<Ref<SpatialGizmo, Shared>>

pub fn global_transform(&self) -> Transform

pub fn get_parent_spatial(&self) -> Option<Ref<Spatial, Shared>>

pub fn rotation(&self) -> Vector3D<f32, UnknownUnit>

pub fn rotation_degrees(&self) -> Vector3D<f32, UnknownUnit>

pub fn scale(&self) -> Vector3D<f32, UnknownUnit>

pub fn transform(&self) -> Transform

pub fn translation(&self) -> Vector3D<f32, UnknownUnit>

pub fn get_world(&self) -> Option<Ref<World, Shared>>

pub fn global_rotate(&self, axis: Vector3D<f32, UnknownUnit>, angle: f64)

pub fn global_scale(&self, scale: Vector3D<f32, UnknownUnit>)

pub fn global_translate(&self, offset: Vector3D<f32, UnknownUnit>)

pub fn hide(&self)

pub fn is_local_transform_notification_enabled(&self) -> bool

pub fn is_scale_disabled(&self) -> bool

pub fn is_set_as_toplevel(&self) -> bool

pub fn is_transform_notification_enabled(&self) -> bool

pub fn is_visible(&self) -> bool

pub fn is_visible_in_tree(&self) -> bool

pub fn look_at(
    &self,
    target: Vector3D<f32, UnknownUnit>,
    up: Vector3D<f32, UnknownUnit>
)

pub fn look_at_from_position(
    &self,
    position: Vector3D<f32, UnknownUnit>,
    target: Vector3D<f32, UnknownUnit>,
    up: Vector3D<f32, UnknownUnit>
)

pub fn orthonormalize(&self)

pub fn rotate(&self, axis: Vector3D<f32, UnknownUnit>, angle: f64)

pub fn rotate_object_local(&self, axis: Vector3D<f32, UnknownUnit>, angle: f64)

pub fn rotate_x(&self, angle: f64)

pub fn rotate_y(&self, angle: f64)

pub fn rotate_z(&self, angle: f64)

pub fn scale_object_local(&self, scale: Vector3D<f32, UnknownUnit>)

pub fn set_as_toplevel(&self, enable: bool)

pub fn set_disable_scale(&self, disable: bool)

pub fn set_gizmo(&self, gizmo: impl AsArg<SpatialGizmo>)

pub fn set_global_transform(&self, global: Transform)

pub fn set_identity(&self)

pub fn set_ignore_transform_notification(&self, enabled: bool)

pub fn set_notify_local_transform(&self, enable: bool)

pub fn set_notify_transform(&self, enable: bool)

pub fn set_rotation(&self, euler: Vector3D<f32, UnknownUnit>)

pub fn set_rotation_degrees(&self, euler_degrees: Vector3D<f32, UnknownUnit>)

pub fn set_scale(&self, scale: Vector3D<f32, UnknownUnit>)

pub fn set_transform(&self, local: Transform)

pub fn set_translation(&self, translation: Vector3D<f32, UnknownUnit>)

pub fn set_visible(&self, visible: bool)

pub fn show(&self)

pub fn to_global(
    &self,
    local_point: Vector3D<f32, UnknownUnit>
) -> Vector3D<f32, UnknownUnit>

pub fn to_local(
    &self,
    global_point: Vector3D<f32, UnknownUnit>
) -> Vector3D<f32, UnknownUnit>

pub fn translate(&self, offset: Vector3D<f32, UnknownUnit>)

pub fn translate_object_local(&self, offset: Vector3D<f32, UnknownUnit>)

pub fn update_gizmo(&self)

Trait Implementations

impl Debug for CollisionObject

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

Formats the value using the given formatter.

impl Deref for CollisionObject

type Target = Spatial

The resulting type after dereferencing.

fn deref(&self) -> &Spatial

Dereferences the value.

impl DerefMut for CollisionObject

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

Mutably dereferences the value.

impl GodotObject for CollisionObject

type RefKind = ManuallyManaged

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 QueueFree for CollisionObject

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<CollisionObject> for Area

impl SubClass<CollisionObject> for RigidBody

impl SubClass<CollisionObject> for PhysicsBody

impl SubClass<CollisionObject> for VehicleBody

impl SubClass<CollisionObject> for KinematicBody

impl SubClass<CollisionObject> for StaticBody

impl SubClass<CollisionObject> for PhysicalBone

impl SubClass<Node> for CollisionObject

impl SubClass<Object> for CollisionObject

impl SubClass<Spatial> for CollisionObject