Struct NodeScene

pub struct NodeScene {
    pub is_owner: bool,
    /* private fields */
}

A recursive structure that allows for the storage, saving, and loading of a dormant scene of nodes. The root node is what every node in the scene will have its owner set to.

Fields

is_owner: bool

Implementations

impl NodeScene

pub fn new<N: Node>(root: N) -> Self

Creates a new NodeScene with a root node.

pub fn new_dyn(root: Box<dyn Node>) -> Self

Creates a new NodeScene from a dynamic node.

pub fn load_from_str(document: &str) -> Result<Self, String>

Loads a NodeScene from a string.

pub fn load(path: &Path) -> Result<Self, String>

Loads a NodeScene from a .scn file.

pub fn save_to_str(&self) -> Result<String, String>

Saves a NodeScene to a string.

pub fn save(&self, path: &Path, name: &str) -> Result<(), String>

Saves a NodeScene to a toml like .scn file.

pub fn structural_hash(&self) -> u64

Recursively builds a hash that represents the scene layout. This will NOT check node fields, but will only compare the shape, ownership, and types present throughout a scene tree.

This can be useful to test for scene changes across loading and saving.

Note

This uses the default hasher. The Hash trait is also implemented to support hashing with other hash functions.

pub fn append(&mut self, child: NodeScene)

Appends a NodeScene as a child.

pub fn append_as_owner(&mut self, child: NodeScene)

Appends an owning NodeScene as a child, ensuring that the root node of the added NodeScene is always an owner.

pub unsafe fn get_node(&self) -> Box<dyn Node>

Returns this NodeScene instance’s associated node.

Safety

This is marked unsafe as if the resulting Box<T> is dropped, the internal pointer could be invalidated.

pub fn children(&self) -> &[NodeScene]

Gets the children.

pub fn update_internal(&self, counter: u64)

Updates the internal RIDs.

Trait Implementations

impl Clone for NodeScene

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeScene

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

Formats the value using the given formatter.

impl Hash for NodeScene

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Instanceable for NodeScene

fn iterate<F: FnMut(Option<*mut dyn Node>, *mut dyn Node, bool)>( self, iterator: F, )

Goes through and iterates through all of the nodes that are represented by this collection. The arguments passed through are the pointers to the parent (if there is one), the node itself, and whether the node is an owner.