Struct graphene::Triangle

pub struct Triangle(_);

A triangle.

Implementations

impl Triangle

pub fn contains_point(&self, p: &Point3D) -> bool

Checks whether the given triangle self contains the point p.

p

a Point3D

Returns

true if the point is inside the triangle

pub fn area(&self) -> f32

Computes the area of the given Triangle.

Returns

the area of the triangle

pub fn barycoords(&self, p: Option<&Point3D>) -> Option<Vec2>

Computes the barycentric coordinates of the given point p.

The point p must lie on the same plane as the triangle self; if the point is not coplanar, the result of this function is undefined.

If we place the origin in the coordinates of the triangle’s A point, the barycentric coordinates are u, which is on the AC vector; and v which is on the AB vector:

The returned Vec2 contains the following values, in order:

• res.x = u
• res.y = v

p

a Point3D

Returns

true if the barycentric coordinates are valid

res

return location for the vector with the barycentric coordinates

pub fn bounding_box(&self) -> Box

Computes the bounding box of the given Triangle.

Returns

res

return location for the box

pub fn midpoint(&self) -> Point3D

Computes the coordinates of the midpoint of the given Triangle.

The midpoint G is the centroid of the triangle, i.e. the intersection of its medians.

Returns

res

return location for the coordinates of the midpoint

pub fn normal(&self) -> Vec3

Computes the normal vector of the given Triangle.

Returns

res

return location for the normal vector

pub fn plane(&self) -> Plane

Computes the plane based on the vertices of the given Triangle.

Returns

res

return location for the plane

pub fn points(&self) -> (Point3D, Point3D, Point3D)

Retrieves the three vertices of the given Triangle and returns their coordinates as Point3D.

Returns

a

return location for the coordinates of the first vertex

b

return location for the coordinates of the second vertex

c

return location for the coordinates of the third vertex

pub fn uv(
    &self,
    p: Option<&Point3D>,
    uv_a: &Vec2,
    uv_b: &Vec2,
    uv_c: &Vec2
) -> Option<Vec2>

Computes the UV coordinates of the given point p.

The point p must lie on the same plane as the triangle self; if the point is not coplanar, the result of this function is undefined. If p is None, the point will be set in (0, 0, 0).

The UV coordinates will be placed in the res vector:

• res.x = u
• res.y = v

See also: barycoords()

p

a Point3D

uv_a

the UV coordinates of the first point

uv_b

the UV coordinates of the second point

uv_c

the UV coordinates of the third point

Returns

true if the coordinates are valid

res

a vector containing the UV coordinates of the given point p

pub fn vertices(&self) -> (Vec3, Vec3, Vec3)

Retrieves the three vertices of the given Triangle.

Returns

a

return location for the first vertex

b

return location for the second vertex

c

return location for the third vertex

pub fn init_from_point3d(
    &mut self,
    a: Option<&Point3D>,
    b: Option<&Point3D>,
    c: Option<&Point3D>
)

Initializes a Triangle using the three given 3D points.

a

a Point3D

b

a Point3D

c

a Point3D

Returns

the initialized Triangle

pub fn init_from_vec3(
    &mut self,
    a: Option<&Vec3>,
    b: Option<&Vec3>,
    c: Option<&Vec3>
)

Initializes a Triangle using the three given vectors.

a

a Vec3

b

a Vec3

c

a Vec3

Returns

the initialized Triangle

impl Triangle

pub fn from_point3d(
    a: Option<&Point3D>,
    b: Option<&Point3D>,
    c: Option<&Point3D>
) -> Triangle

pub fn from_vec3(
    a: Option<&Vec3>,
    b: Option<&Vec3>,
    c: Option<&Vec3>
) -> Triangle

Trait Implementations

impl Clone for Triangle

fn clone(&self) -> Triangle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Triangle

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

Formats the value using the given formatter.

impl Hash for Triangle

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for Triangle

fn cmp(&self, other: &Triangle) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Triangle> for Triangle

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Triangle> for Triangle

fn partial_cmp(&self, other: &Triangle) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Triangle

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Triangle