Struct kiss3d::scene::SceneNode

source · [−]

pub struct SceneNode { /* private fields */ }

Expand description

A node of the scene graph.

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

Implementations

source

impl SceneNode

source

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

Creates a new scene node that is not rooted.

source

pub fn new_empty() -> SceneNode

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

source

pub fn unlink(&mut self)

Removes this node from its parent.

source

pub fn data(&self) -> Ref<'_, SceneNodeData>

The data of this scene node.

source

pub fn data_mut(&mut self) -> RefMut<'_, SceneNodeData>

The data of this scene node.

source

pub fn add_group(&mut self) -> SceneNode

Adds a node without object to this node children.

source

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

Adds a node as a child of parent.

Failures:

Fails if node already has a parent.

source

pub 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.

source

pub 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 x axis
wy - the cube extent along the y axis
wz - the cube extent along the z axis

source

pub 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).

pub 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

source

pub 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

source

pub 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

source

pub 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.

source

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

Adds a double-sided quad with the specified vertices.

source

pub 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.

source

pub 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.

source

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

Creates and adds a new object using a mesh descriptor.

source

pub 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.

source

pub 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.

source

pub 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.

source

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

Render the scene graph rooted by this node.

source

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

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

source

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

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

source

pub 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.

source

pub fn set_lines_color(&mut self, color: Option<Point3<f32>>)

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

source

pub 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.

source

pub 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.

source

pub fn enable_backface_culling(&mut self, active: bool)

Activates or deactivates backface culling for the objects contained by this node and its children.

source

pub fn modify_vertices<F: FnMut(&mut Vec<Point3<f32>>)>(&mut self, f: &mut F)

Mutably accesses the vertices of the objects contained by this node and its children.

The provided closure is called once per object.

source

pub fn read_vertices<F: FnMut(&[Point3<f32>])>(&self, f: &mut F)

Accesses the vertices of the objects contained by this node and its children.

The provided closure is called once per object.

source

pub fn recompute_normals(&mut self)

Recomputes the normals of the meshes of the objects contained by this node and its children.

source

pub fn modify_normals<F: FnMut(&mut Vec<Vector3<f32>>)>(&mut self, f: &mut F)

Mutably accesses the normals of the objects contained by this node and its children.

The provided closure is called once per object.

source

pub fn read_normals<F: FnMut(&[Vector3<f32>])>(&self, f: &mut F)

Accesses the normals of the objects contained by this node and its children.

The provided closure is called once per object.

source

pub fn modify_faces<F: FnMut(&mut Vec<Point3<u16>>)>(&mut self, f: &mut F)

Mutably accesses the faces of the objects contained by this node and its children.

The provided closure is called once per object.

source

pub fn read_faces<F: FnMut(&[Point3<u16>])>(&self, f: &mut F)

Accesses the faces of the objects contained by this node and its children.

The provided closure is called once per object.

source

pub fn modify_uvs<F: FnMut(&mut Vec<Point2<f32>>)>(&mut self, f: &mut F)

Mutably accesses the texture coordinates of the objects contained by this node and its children.

The provided closure is called once per object.

source

pub fn read_uvs<F: FnMut(&[Point2<f32>])>(&self, f: &mut F)

Accesses the texture coordinates of the objects contained by this node and its children.

The provided closure is called once per object.

source

pub fn is_visible(&self) -> bool

Get the visibility status of node.

source

pub fn set_visible(&mut self, visible: bool)

Sets the visibility of this node.

The node and its children are not rendered if it is not visible.

source

pub fn set_color(&mut self, r: f32, g: f32, b: f32)

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

Colors components must be on the range [0.0, 1.0].

source

pub fn set_texture_from_file(&mut self, path: &Path, name: &str)

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

The texture is loaded from a file and registered by the global TextureManager.

Arguments

path - relative path of the texture on the disk

source

pub fn set_texture_from_memory(&mut self, image_data: &[u8], name: &str)

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

The texture is loaded from a file and registered by the global TextureManager.

Arguments

image_data - slice of bytes containing encoded image
name - &str to identify this texture in TextureManager

source

pub fn set_texture_with_name(&mut self, name: &str)

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

The texture must already have been registered as name.

source

pub fn set_texture(&mut self, texture: Rc<Texture>)

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

source

pub fn set_local_scale(&mut self, sx: f32, sy: f32, sz: f32)

Sets the local scaling factors of the object.

source

pub fn reorient(&mut self, eye: &Point3<f32>, at: &Point3<f32>, up: &Vector3<f32>)

Move and orient the object such that it is placed at the point eye and have its x axis oriented toward at.

source

pub fn append_transformation(&mut self, t: &Isometry3<f32>)

Appends a transformation to this node local transformation.

source

pub fn prepend_to_local_transformation(&mut self, t: &Isometry3<f32>)

Prepends a transformation to this node local transformation.

source

pub fn set_local_transformation(&mut self, t: Isometry3<f32>)

Set this node local transformation.

source

pub fn append_translation(&mut self, t: &Translation3<f32>)

Appends a translation to this node local transformation.

source

pub fn prepend_to_local_translation(&mut self, t: &Translation3<f32>)

Prepends a translation to this node local transformation.

source

pub fn set_local_translation(&mut self, t: Translation3<f32>)

Sets the local translation of this node.

source

pub fn append_rotation(&mut self, r: &UnitQuaternion<f32>)

Appends a rotation to this node local transformation.

source

pub fn append_rotation_wrt_center(&mut self, r: &UnitQuaternion<f32>)

Appends a rotation to this node local transformation.

source

pub fn prepend_to_local_rotation(&mut self, r: &UnitQuaternion<f32>)

Prepends a rotation to this node local transformation.

source

pub fn set_local_rotation(&mut self, r: UnitQuaternion<f32>)

Sets the local rotation of this node.

Trait Implementations

source

impl Clone for SceneNode

source

fn clone(&self) -> SceneNode

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

Auto Trait Implementations

impl !RefUnwindSafe for SceneNode

impl !Send for SceneNode

impl !Sync for SceneNode

impl Unpin for SceneNode

impl !UnwindSafe for SceneNode

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast for T where
T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · 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.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct kiss3d::scene::SceneNode

Implementations

impl SceneNode

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

pub fn new_empty() -> SceneNode

pub fn unlink(&mut self)

pub fn data(&self) -> Ref<'_, SceneNodeData>

pub fn data_mut(&mut self) -> RefMut<'_, SceneNodeData>

pub fn add_group(&mut self) -> SceneNode

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub fn set_lines_color(&mut self, color: Option<Point3<f32>>)

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

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

pub fn enable_backface_culling(&mut self, active: bool)

pub fn modify_vertices<F: FnMut(&mut Vec<Point3<f32>>)>(&mut self, f: &mut F)

pub fn read_vertices<F: FnMut(&[Point3<f32>])>(&self, f: &mut F)

pub fn recompute_normals(&mut self)

pub fn modify_normals<F: FnMut(&mut Vec<Vector3<f32>>)>(&mut self, f: &mut F)

pub fn read_normals<F: FnMut(&[Vector3<f32>])>(&self, f: &mut F)

pub fn modify_faces<F: FnMut(&mut Vec<Point3<u16>>)>(&mut self, f: &mut F)

pub fn read_faces<F: FnMut(&[Point3<u16>])>(&self, f: &mut F)

pub fn modify_uvs<F: FnMut(&mut Vec<Point2<f32>>)>(&mut self, f: &mut F)

pub fn read_uvs<F: FnMut(&[Point2<f32>])>(&self, f: &mut F)

pub fn is_visible(&self) -> bool

pub fn set_visible(&mut self, visible: bool)

pub fn set_color(&mut self, r: f32, g: f32, b: f32)

pub fn set_texture_from_file(&mut self, path: &Path, name: &str)

pub fn set_texture_from_memory(&mut self, image_data: &[u8], name: &str)

pub fn set_texture_with_name(&mut self, name: &str)

pub fn set_texture(&mut self, texture: Rc<Texture>)

pub fn set_local_scale(&mut self, sx: f32, sy: f32, sz: f32)

pub fn reorient(&mut self, eye: &Point3<f32>, at: &Point3<f32>, up: &Vector3<f32>)

pub fn append_transformation(&mut self, t: &Isometry3<f32>)

pub fn prepend_to_local_transformation(&mut self, t: &Isometry3<f32>)

pub fn set_local_transformation(&mut self, t: Isometry3<f32>)

pub fn append_translation(&mut self, t: &Translation3<f32>)

pub fn prepend_to_local_translation(&mut self, t: &Translation3<f32>)

pub fn set_local_translation(&mut self, t: Translation3<f32>)

pub fn append_rotation(&mut self, r: &UnitQuaternion<f32>)

pub fn append_rotation_wrt_center(&mut self, r: &UnitQuaternion<f32>)

pub fn prepend_to_local_rotation(&mut self, r: &UnitQuaternion<f32>)

pub fn set_local_rotation(&mut self, r: UnitQuaternion<f32>)

Trait Implementations

impl Clone for SceneNode

fn clone(&self) -> SceneNode

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

Auto Trait Implementations

impl !RefUnwindSafe for SceneNode

impl !Send for SceneNode

impl !Sync for SceneNode

impl Unpin for SceneNode

impl !UnwindSafe for SceneNode

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Downcast for T where T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

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

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

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

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

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

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

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> Downcast for T where
T: Any,

impl<T, U> Into<U> for T where
U: From<T>,

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,