Struct Node

pub struct Node {

    pub id: Option<String>,
    pub name: Option<String>,
    pub sid: Option<String>,
    pub ty: NodeType,
    pub layer: Vec<String>,
    pub asset: Option<Box<Asset>>,
    pub transforms: Vec<Transform>,
    pub instance_camera: Vec<Instance<Camera>>,
    pub instance_controller: Vec<Instance<Controller>>,
    pub instance_geometry: Vec<Instance<Geometry>>,
    pub instance_light: Vec<Instance<Light>>,
    pub instance_node: Vec<Instance<Node>>,
    pub children: Vec<Node>,
    pub extra: Vec<Extra>,
}

Embodies the hierarchical relationship of elements in a scene.

The Node element declares a point of interest in a scene. A node denotes one point on a branch of the scene graph. The Node element is essentially the root of a subgraph of the entire scene graph.

Fields

id: Option<String>

A text string containing the unique identifier of the element.

name: Option<String>

The text string name of this element.

sid: Option<String>

A text string value containing the subidentifier of this element. This value must be unique within the scope of the parent element.

ty: NodeType

The type of the Node element.

layer: Vec<String>

The layers to which this node belongs.

asset: Option<Box<Asset>>

Asset management information about this element.

transforms: Vec<Transform>

Any combination of geometric transforms.

instance_camera: Vec<Instance<Camera>>

Allows the node to instantiate a camera object.

instance_controller: Vec<Instance<Controller>>

Allows the node to instantiate a controller object.

instance_geometry: Vec<Instance<Geometry>>

Allows the node to instantiate a geometry object.

instance_light: Vec<Instance<Light>>

Allows the node to instantiate a light object.

instance_node: Vec<Instance<Node>>

Allows the node to instantiate a hierarchy of other nodes.

children: Vec<Node>

Allows the node to recursively define hierarchy.

extra: Vec<Extra>

Provides arbitrary additional information about this element.

Implementations

impl Node

pub fn new(id: impl Into<String>, name: Option<String>) -> Self

Construct a new default node with the given id and name.

pub fn push_transform(&mut self, transform: impl Into<Transform>)

Add a transform to this node’s transformation stack.

pub fn is_empty(&self) -> bool

Returns true if this node has no sub-elements.

Trait Implementations

impl Clone for Node

fn clone(&self) -> Node

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Node

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

Formats the value using the given formatter.

impl HasId for Node

fn id(&self) -> Option<&str>

Get the ID of the node.

fn get_local_map<'a, 'b>( maps: &'b LocalMaps<'a>, ) -> &'b Option<LocalMap<'a, Self>>

Extract the relevant LocalMap field from a LocalMaps.

fn get_local_map_mut<'a, 'b>( maps: &'b mut LocalMaps<'a>, ) -> &'b mut Option<LocalMap<'a, Self>>

Extract the relevant LocalMap field from a LocalMaps.

impl ParseLibrary for Node

const LIBRARY: &'static str = "library_nodes"

The name of the library element. For example, the Geometry element has LIBRARY = "library_geometries", and the corresponding library type is Library<Geometry>.

fn extract_element(e: &LibraryElement) -> Option<&Library<Self>>

Extract the library from a single LibraryElement.

fn mk_element(lib: Library<Self>) -> LibraryElement

Make a LibraryElement from a Library.

impl Traversable for Node

fn traverse<'a, E>( doc: &'a Document, f: impl FnMut(&'a Node) -> Result<(), E>, ) -> Result<(), E>

Run the function f on all elements of type Self in the document doc.