Struct three_d::renderer::geometry::Line

pub struct Line { /* private fields */ }

A rectangle 2D geometry which can be rendered using a camera created by Camera::new_2d.

Implementations

impl Line

pub fn new( context: &Context, pixel0: impl Into<PhysicalPoint>, pixel1: impl Into<PhysicalPoint>, thickness: f32 ) -> Self

Constructs a new line geometry.

pub fn end_point0(&self) -> PhysicalPoint

Get one of the end points of the line.

pub fn end_point1(&self) -> PhysicalPoint

Get one of the end points of the line.

pub fn set_endpoints( &mut self, pixel0: impl Into<PhysicalPoint>, pixel1: impl Into<PhysicalPoint> )

Change the two end points of the line. The pixel coordinates must be in physical pixels, where (viewport.x, viewport.y) indicate the top left corner of the viewport and (viewport.x + viewport.width, viewport.y + viewport.height) indicate the bottom right corner.

pub fn set_thickness(&mut self, thickness: f32)

Set the line thickness.

Methods from Deref<Target = Mesh>

pub fn transformation(&self) -> Mat4

Returns the local to world transformation applied to this mesh.

pub fn set_transformation(&mut self, transformation: Mat4)

Set the local to world transformation applied to this mesh. If any animation method is set using Self::set_animation, the transformation from that method is applied before this transformation.

pub fn set_animation( &mut self, animation: impl Fn(f32) -> Mat4 + Send + Sync + 'static )

Specifies a function which takes a time parameter as input and returns a transformation that should be applied to this mesh at the given time. To actually animate this mesh, call Geometry::animate at each frame which in turn evaluates the animation function defined by this method. This transformation is applied first, then the local to world transformation defined by Self::set_transformation.

pub fn vertex_count(&self) -> u32

Returns the number of vertices in this mesh.

pub fn update_positions(&mut self, positions: &[Vector3<f32>])

Updates the vertex positions of the mesh.

Panics

Panics if the number of positions does not match the number of vertices in the mesh.

pub fn update_normals(&mut self, normals: &[Vector3<f32>])

Updates the vertex normals of the mesh.

Panics

Panics if the number of normals does not match the number of vertices in the mesh.

Trait Implementations

impl Deref for Line

type Target = Mesh

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Line

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Geometry for Line

fn draw( &self, camera: &Camera, program: &Program, render_states: RenderStates, attributes: FragmentAttributes )

Draw this geometry.

fn vertex_shader_source( &self, required_attributes: FragmentAttributes ) -> String

Returns the vertex shader source for this geometry given that the fragment shader needs the given vertex attributes.

fn id(&self, required_attributes: FragmentAttributes) -> u16

Returns a unique ID for each variation of the shader source returned from Geometry::vertex_shader_source.

fn render_with_material( &self, material: &dyn Material, camera: &Camera, lights: &[&dyn Light] )

Render the geometry with the given Material. Must be called in the callback given as input to a RenderTarget, ColorTarget or DepthTarget write method. Use an empty array for the lights argument, if the material does not require lights to be rendered.

fn render_with_effect( &self, material: &dyn Effect, camera: &Camera, lights: &[&dyn Light], color_texture: Option<ColorTexture<'_>>, depth_texture: Option<DepthTexture<'_>> )

Render the geometry with the given Effect. Must be called in the callback given as input to a RenderTarget, ColorTarget or DepthTarget write method. Use an empty array for the lights argument, if the material does not require lights to be rendered.

fn aabb(&self) -> AxisAlignedBoundingBox

Returns the AxisAlignedBoundingBox for this geometry in the global coordinate system.

fn animate(&mut self, time: f32)

For updating the animation of this geometry if it is animated, if not, this method does nothing. The time parameter should be some continious time, for example the time since start.

impl<'a> IntoIterator for &'a Line

type Item = &'a dyn Geometry

The type of the elements being iterated over.

type IntoIter = Once<&'a dyn Geometry>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.