Struct three::template::ObjectTemplate

pub struct ObjectTemplate {
    pub name: Option<String>,
    pub parent: Option<usize>,
    pub transform: Transform,
}

Common data used by all object types.

All objects (i.e. three-rs types that implement the Object trait) have common data that the user can set at runtime. ObjectTemplate encapsultes these fields, and the various template types have a way to reference an ObjectTemplate to specify the object data for that template.

See the module documentation for more information on how object data is defined in templates.

Fields

name: Option<String>

An optional name for the object.

parent: Option<usize>

The parent Group of the object, given as an index into the [groups] array of the parent Template.

If parent is None, then the object is added to the root Group returned from [Factory::instantiate_template].

transform: Transform

The local transform for the object.

Implementations

impl ObjectTemplate

pub fn new() -> ObjectTemplate

Creates a new ObjectTemplate with default values.

The new object template will have no name, no parent (i.e. it will be treated as a root object of the template), and a default transform.

Examples

use three::template::{ObjectTemplate, Template};

let mut template = Template::new();

let mut object = ObjectTemplate::new();
object.name = Some("My Node".into());
object.transform.position = [1.0, 2.0, 3.0].into();

template.objects.push(object);

Trait Implementations

impl Clone for ObjectTemplate

fn clone(&self) -> ObjectTemplate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectTemplate

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

Formats the value using the given formatter.

impl Default for ObjectTemplate

fn default() -> ObjectTemplate

Returns the “default value” for a type.