Gizmo

Struct Gizmo 

Source
pub struct Gizmo { /* private fields */ }
Expand description

A 3D transformation gizmo.

Implementations§

Source§

impl Gizmo

Source

pub fn new(config: GizmoConfig) -> Self

Creates a new gizmo from given configuration

Source

pub fn config(&self) -> &GizmoConfig

Current configuration used by the gizmo.

Source

pub fn update_config(&mut self, config: GizmoConfig)

Updates the configuration used by the gizmo.

Source

pub fn is_focused(&self) -> bool

Was this gizmo focused after the latest Gizmo::update call.

Source

pub fn update( &mut self, interaction: GizmoInteraction, targets: &[Transform], ) -> Option<(GizmoResult, Vec<Transform>)>

Updates the gizmo based on given interaction information.

§Examples

let interaction = GizmoInteraction {
    cursor_pos,
    hovered,
    drag_started,
    dragging
};

if let Some((_result, new_transforms)) = gizmo.update(interaction, &transforms) {
                for (new_transform, transform) in
    // Update transforms
    new_transforms.iter().zip(&mut transforms)
    {
        *transform = *new_transform;
    }
}

Returns the result of the interaction with the updated transformation.

Some is returned when any of the subgizmos is being dragged, None otherwise.

Source

pub fn draw(&self) -> GizmoDrawData

Return all the necessary data to draw the latest gizmo interaction.

The gizmo draw data consists of vertices in viewport coordinates.

Source

pub fn pick_preview(&self, cursor_pos: (f32, f32)) -> bool

Checks all sub-gizmos for intersections with the cursor. If there is one, return true.

Trait Implementations§

Source§

impl Clone for Gizmo

Source§

fn clone(&self) -> Gizmo

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Gizmo

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Gizmo

Source§

fn default() -> Gizmo

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Gizmo

§

impl RefUnwindSafe for Gizmo

§

impl Send for Gizmo

§

impl Sync for Gizmo

§

impl Unpin for Gizmo

§

impl UnwindSafe for Gizmo

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.