Struct graphene::Triangle

#[repr(transparent)]
pub struct Triangle { /* private fields */ }

A triangle.

Implementations

impl Triangle

pub fn as_ptr(&self) -> *mut graphene_triangle_t

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

impl Triangle

pub fn from_float(a: [f32; 3], b: [f32; 3], c: [f32; 3]) -> Self

Initializes a Triangle using the three given arrays of floating point values, each representing the coordinates of a point in 3D space.

a

an array of 3 floating point values

b

an array of 3 floating point values

c

an array of 3 floating point values

Returns

the initialized Triangle

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

Initializes a Triangle using the three given 3D points.

a

a Point3D

b

a Point3D

c

a Point3D

Returns

the initialized Triangle

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

Initializes a Triangle using the three given vectors.

a

a Vec3

b

a Vec3

c

a Vec3

Returns

the initialized Triangle

Trait Implementations

impl Clone for Triangle

fn clone(&self) -> Self

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 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StaticType for Triangle

fn static_type() -> Type

Returns the type identifier of Self.

impl Copy for Triangle

impl Eq for Triangle