Struct kiss3d::scene::SceneNode [−] [src]

pub struct SceneNode { /* fields omitted */ }

A node of the scene graph.

This may represent a group of other nodes, and/or contain an object that can be rendered.

Methods

`impl SceneNode`
[src]

`fn new(local_scale: Vector3<f32>, local_transform: Isometry3<f32>, object: Option<Object>) -> SceneNode`

Creates a new scene node that is not rooted.

`fn new_empty() -> SceneNode`

Creates a new empty, not rooted, node with identity transformations.

`fn unlink(&mut self)`

Removes this node from its parent.

`fn data(&self) -> Ref<SceneNodeData>`

The data of this scene node.

`fn data_mut(&mut self) -> RefMut<SceneNodeData>`

The data of this scene node.

`fn add_group(&mut self) -> SceneNode`

Adds a node without object to this node children.

`fn add_child(&mut self, node: SceneNode)`

Adds a node as a child of parent.

Failures:

Fails if node already has a parent.

`fn add_object(&mut self, local_scale: Vector3<f32>, local_transform: Isometry3<f32>, object: Object) -> SceneNode`

Adds a node containing an object to this node children.

`fn add_cube(&mut self, wx: f32, wy: f32, wz: f32) -> SceneNode`

Adds a cube as a children of this node. The cube is initially axis-aligned and centered at (0, 0, 0).

Arguments

wx - the cube extent along the z axis
wy - the cube extent along the y axis
wz - the cube extent along the z axis

`fn add_sphere(&mut self, r: f32) -> SceneNode`

Adds a sphere as a children of this node. The sphere is initially centered at (0, 0, 0).

Arguments

r - the sphere radius

`fn add_cone(&mut self, r: f32, h: f32) -> SceneNode`

Adds a cone to the scene. The cone is initially centered at (0, 0, 0) and points toward the positive y axis.

Arguments

h - the cone height
r - the cone base radius

`fn add_cylinder(&mut self, r: f32, h: f32) -> SceneNode`

Adds a cylinder to this node children. The cylinder is initially centered at (0, 0, 0) and has its principal axis aligned with the y axis.

Arguments

h - the cylinder height
r - the cylinder base radius

`fn add_capsule(&mut self, r: f32, h: f32) -> SceneNode`

Adds a capsule to this node children. The capsule is initially centered at (0, 0, 0) and has its principal axis aligned with the y axis.

Arguments

h - the capsule height
r - the capsule caps radius

`fn add_quad(&mut self, w: f32, h: f32, usubdivs: usize, vsubdivs: usize) -> SceneNode`

Adds a double-sided quad to this node children. The quad is initially centered at (0, 0, 0). The quad itself is composed of a user-defined number of triangles regularly spaced on a grid. This is the main way to draw height maps.

Arguments

w - the quad width.
h - the quad height.
wsubdivs - number of horizontal subdivisions. This correspond to the number of squares which will be placed horizontally on each line. Must not be 0.
hsubdivs - number of vertical subdivisions. This correspond to the number of squares which will be placed vertically on each line. Must not be 0. update.

`fn add_quad_with_vertices(&mut self, vertices: &[Point3<f32>], nhpoints: usize, nvpoints: usize) -> SceneNode`

Adds a double-sided quad with the specified vertices.

`fn add_geom_with_name(&mut self, geometry_name: &str, scale: Vector3<f32>) -> Option<SceneNode>`

Creates and adds a new object using the geometry registered as geometry_name.

`fn add_mesh(&mut self, mesh: Rc<RefCell<Mesh>>, scale: Vector3<f32>) -> SceneNode`

Creates and adds a new object to this node children using a mesh.

`fn add_trimesh(&mut self, descr: TriMesh3<f32>, scale: Vector3<f32>) -> SceneNode`

Creates and adds a new object using a mesh descriptor.

`fn add_obj(&mut self, path: &Path, mtl_dir: &Path, scale: Vector3<f32>) -> SceneNode`

Creates and adds multiple nodes created from an obj file.

This will create a new node serving as a root of the scene described by the obj file. This newly created node is added to this node's children.

`fn apply_to_scene_nodes_mut<F: FnMut(&mut SceneNode)>(&mut self, f: &mut F)`

Applies a closure to each object contained by this node and its children.

`fn apply_to_scene_nodes<F: FnMut(&SceneNode)>(&self, f: &mut F)`

Applies a closure to each object contained by this node and its children.

`fn render(&mut self, pass: usize, camera: &mut Camera, light: &Light)`

Render the scene graph rooted by this node.

`fn set_material(&mut self, material: Rc<RefCell<Box<Material + 'static>>>)`

Sets the material of the objects contained by this node and its children.

`fn set_material_with_name(&mut self, name: &str)`

Sets the material of the objects contained by this node and its children.

`fn set_lines_width(&mut self, width: f32)`

Sets the width of the lines drawn for the objects contained by this node and its children.

`fn set_points_size(&mut self, size: f32)`

Sets the size of the points drawn for the objects contained by this node and its children.

`fn set_surface_rendering_activation(&mut self, active: bool)`

Activates or deactivates the rendering of the surfaces of the objects contained by this node and its children.