Skip to main content

Object

Struct Object 

Source
pub struct Object {
    pub name: String,
    pub transform: Transform,
    pub geometry: Option<Geometry>,
    pub color: [f32; 4],
    pub children: Vec<usize>,
    pub parent: Option<usize>,
    pub str_id: String,
    pub texture_path: Option<String>,
}
Expand description

A node in the scene graph.

Every visible or logical entity in a scene is represented by an Object. Objects are stored in and managed by a crate::world::World; use crate::world::World::spawn_object (or crate::scene::Scene::spawn) to insert them.

§Hierarchy

Parent-child relationships are tracked via the Object::parent and Object::children integer-ID lists. Do not mutate these directly: use crate::world::World::reparent and crate::world::World::delete to keep the hierarchy consistent.

§Identity

Each object has two identifiers:

Fields§

§name: String

Human-readable display name (does not need to be unique).

§transform: Transform

Local-space transform (position, rotation, scale) relative to the parent, or to world origin if at the scene root.

§geometry: Option<Geometry>

Optional procedural geometry attached to this object. None means the object is invisible (useful for empty pivot nodes).

§color: [f32; 4]

RGBA base color multiplied with the geometry during rendering. Values outside [0.0, 1.0] are currently clamped by the shader.

§children: Vec<usize>

Integer IDs of direct children. Managed by crate::world::World; do not mutate directly.

§parent: Option<usize>

Integer ID of the parent object, or None if this is a root object. Managed by crate::world::World; do not mutate directly.

§str_id: String

Stable string identifier used as a human-friendly handle. Should be unique within a world. Use crate::world::World::rename_str_id to change it after spawn.

§texture_path: Option<String>

Path to a texture image applied to this object’s surface.

Implementations§

Source§

impl Object

Source

pub fn new(config: ObjectConstructor) -> Self

Create a new object from an ObjectConstructor configuration.

None fields fall back to their defaults:

  • transform -> identity
  • str_id -> random UUID
  • color -> opaque white
  • geometry -> None (invisible)
Source

pub fn from_geometry( name: &str, str_id: Option<String>, geometry: Geometry, transform: Transform, color: [f32; 4], ) -> Self

Convenience constructor for an object with a known geometry, transform, and color.

  • name - display name.
  • str_id - stable string handle; a random UUID is used if None.
  • geometry - shape attached to the object.
  • transform- initial local transform.
  • color - RGBA base color.

Trait Implementations§

Source§

impl Clone for Object

Source§

fn clone(&self) -> Object

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 Object

Source§

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

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

impl Default for Object

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for Object

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Object

Source§

fn eq(&self, other: &Object) -> 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 Serialize for Object

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Object

Auto Trait Implementations§

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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,