Struct NodeId

Source
#[repr(C)]
pub struct NodeId { /* private fields */ }
Expand description

Identifier for a Node.

IDs must be unique within the editor context. Generated using IdentifierGenerator::next_node.

Implementations§

Source§

impl NodeId

Source

pub fn set_draggable(&self, draggable: bool) -> &Self

Sets whether this node can be dragged by the user.

Source

pub fn move_editor_to(&self) -> &Self

Pans the editor view to center on this node.

Source

pub fn get_dimensions(&self) -> ImVec2

Gets the dimensions (width, height) of this node.

Note: This must be called after the node has been submitted in the current frame, otherwise the dimensions might be outdated or zero.

Source

pub fn set_position( &self, x: f32, y: f32, coordinate_system: CoordinateSystem, ) -> &Self

Sets the position of the top-left corner of this node in the specified coordinate system.

Source

pub fn get_position(&self, coordinate_system: CoordinateSystem) -> ImVec2

Gets the position of the top-left corner of this node in the specified coordinate system.

Note: This must be called after the node has been submitted in the current frame, otherwise the position might be outdated.

Source

pub fn snap_to_grid(&self) -> &Self

Aligns the node’s top-left corner to the grid lines. Requires the StyleFlags::GridSnapping flag to be enabled in the style.

Source

pub fn select(&self) -> &Self

Selects this node.

Source

pub fn deselect(&self) -> &Self

Deselects this node. If no other nodes are selected, this is equivalent to EditorContext::clear_node_selection.

Source

pub fn is_selected(&self) -> bool

Checks if this node is currently selected.

Trait Implementations§

Source§

impl Clone for NodeId

Source§

fn clone(&self) -> NodeId

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 NodeId

Source§

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

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

impl From<NodeId> for i32

Source§

fn from(val: NodeId) -> Self

Converts to this type from the input type.
Source§

impl Hash for NodeId

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Hoverable for NodeId

Source§

fn is_hovered(&self, _scope: &OuterScope) -> bool

Checks if the node is hovered.

Source§

impl PartialEq for NodeId

Source§

fn eq(&self, other: &NodeId) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for NodeId

Source§

impl Eq for NodeId

Source§

impl StructuralPartialEq for NodeId

Auto Trait Implementations§

§

impl Freeze for NodeId

§

impl RefUnwindSafe for NodeId

§

impl Send for NodeId

§

impl Sync for NodeId

§

impl Unpin for NodeId

§

impl UnwindSafe for NodeId

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.