Skip to main content

Object

Struct Object 

Source
pub struct Object<'a> { /* private fields */ }
Expand description

Base class for Usd scenegraph objects, providing common API.

The commonality between the three types of scenegraph objects in Usd (usd::Prim, usd::Attribute, usd::Relationship) is that they can all have metadata. Other objects in the API simply are kinds of metadata.

Inheritance hierarchy:

Implementations§

Source§

impl<'a> Object<'a>

Source

pub fn stage(&self) -> &Stage

Source

pub fn path(&self) -> &Path

Source

pub fn metadata<T: ValueType>(&self, key: &Token) -> Option<T>

Source

pub fn documentation(&self) -> String

Return this object’s documentation (metadata).

This returns the empty string if no documentation has been set.

Source

pub fn custom_data(&self) -> Dictionary

Return this object’s composed customData dictionary.

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for Object<'a>

§

impl<'a> !Send for Object<'a>

§

impl<'a> !Sync for Object<'a>

§

impl<'a> !UnwindSafe for Object<'a>

§

impl<'a> Freeze for Object<'a>

§

impl<'a> Unpin for Object<'a>

§

impl<'a> UnsafeUnpin for Object<'a>

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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.