This class is an helper class associated to the AIFMesh structure. AIFPropertiesHelpers implements all the basic geometric function used to manipulate an AIFMesh point coordinates, and to compute normals or edge length. Any such geometric operation on the AIF structure need to be realized with this helper class. More...

#include <AIFPropertiesHelpers.h>

Collaboration diagram for FEVV::DataStructures::AIF::AIFPropertiesHelpers:

Public Types
typedef FEVV::DataStructures::AIF::AIFMesh	AIFMesh

typedef AIFMesh::CoordinateType	CoordinateType

typedef AIFMesh::NormalCoordinateType	NormalCoordinateType

typedef AIFMesh::Point	Point

typedef AIFMesh::Vector	Vector

typedef AIFTopologyHelpers::smart_ptr_mesh	smart_ptr_mesh

typedef AIFTopologyHelpers::ptr_mesh	ptr_mesh

typedef AIFTopologyHelpers::ref_mesh	ref_mesh

typedef AIFTopologyHelpers::vertex_descriptor	vertex_descriptor

typedef AIFTopologyHelpers::edge_descriptor	edge_descriptor

Static Public Member Functions
static void	set_point (const ptr_mesh m, vertex_descriptor v, CoordinateType x, CoordinateType y, CoordinateType z)

static void	set_point (const smart_ptr_mesh m, vertex_descriptor v, CoordinateType x, CoordinateType y, CoordinateType z)

static void	set_point (ref_mesh m, vertex_descriptor v, CoordinateType x, CoordinateType y, CoordinateType z)

static Point &	get_point (const ptr_mesh m, vertex_descriptor v)

static Point &	get_point (const smart_ptr_mesh m, vertex_descriptor v)

static Point &	get_point (ref_mesh m, vertex_descriptor v)

static Vector	compute_normal (const Point &p1, const Point &p2, const Point &p3)

template<typename mesh >
static Vector	compute_normal (const mesh m, const vertex_descriptor v1, const vertex_descriptor v2, const vertex_descriptor v3)

static Vector	compute_unit_normal (const Point &p1, const Point &p2, const Point &p3)

template<typename mesh >
static Vector	compute_unit_normal (const mesh m, const vertex_descriptor v1, const vertex_descriptor v2, const vertex_descriptor v3)

template<typename mesh >
static CoordinateType	length (const mesh m, const edge_descriptor e)

Detailed Description

This class is an helper class associated to the AIFMesh structure. AIFPropertiesHelpers implements all the basic geometric function used to manipulate an AIFMesh point coordinates, and to compute normals or edge length. Any such geometric operation on the AIF structure need to be realized with this helper class.

See also: AIFMesh

Definition at line 27 of file AIFPropertiesHelpers.h.

Member Typedef Documentation

◆ AIFMesh

typedef FEVV::DataStructures::AIF::AIFMesh FEVV::DataStructures::AIF::AIFPropertiesHelpers::AIFMesh

Definition at line 30 of file AIFPropertiesHelpers.h.

◆ CoordinateType

typedef AIFMesh::CoordinateType FEVV::DataStructures::AIF::AIFPropertiesHelpers::CoordinateType

Definition at line 31 of file AIFPropertiesHelpers.h.

◆ edge_descriptor

typedef AIFTopologyHelpers::edge_descriptor FEVV::DataStructures::AIF::AIFPropertiesHelpers::edge_descriptor

Definition at line 39 of file AIFPropertiesHelpers.h.

◆ NormalCoordinateType

typedef AIFMesh::NormalCoordinateType FEVV::DataStructures::AIF::AIFPropertiesHelpers::NormalCoordinateType

Definition at line 32 of file AIFPropertiesHelpers.h.

◆ Point

typedef AIFMesh::Point FEVV::DataStructures::AIF::AIFPropertiesHelpers::Point

Definition at line 33 of file AIFPropertiesHelpers.h.

◆ ptr_mesh

typedef AIFTopologyHelpers::ptr_mesh FEVV::DataStructures::AIF::AIFPropertiesHelpers::ptr_mesh

Definition at line 36 of file AIFPropertiesHelpers.h.

◆ ref_mesh

typedef AIFTopologyHelpers::ref_mesh FEVV::DataStructures::AIF::AIFPropertiesHelpers::ref_mesh

Definition at line 37 of file AIFPropertiesHelpers.h.

◆ smart_ptr_mesh

typedef AIFTopologyHelpers::smart_ptr_mesh FEVV::DataStructures::AIF::AIFPropertiesHelpers::smart_ptr_mesh

Definition at line 35 of file AIFPropertiesHelpers.h.

◆ Vector

typedef AIFMesh::Vector FEVV::DataStructures::AIF::AIFPropertiesHelpers::Vector

Definition at line 34 of file AIFPropertiesHelpers.h.

◆ vertex_descriptor

typedef AIFTopologyHelpers::vertex_descriptor FEVV::DataStructures::AIF::AIFPropertiesHelpers::vertex_descriptor

Definition at line 38 of file AIFPropertiesHelpers.h.

Member Function Documentation

◆ compute_normal() [1/2]

template<typename mesh >

static Vector FEVV::DataStructures::AIF::AIFPropertiesHelpers::compute_normal	(	const mesh	m,
		const vertex_descriptor	v1,
		const vertex_descriptor	v2,
		const vertex_descriptor	v3
	)

inlinestatic

Compute the normal (non unitary) of the plane defined by the three vertices.

Definition at line 154 of file AIFPropertiesHelpers.h.

Here is the call graph for this function:

◆ compute_normal() [2/2]

static Vector FEVV::DataStructures::AIF::AIFPropertiesHelpers::compute_normal	(	const Point &	p1,
		const Point &	p2,
		const Point &	p3
	)

inlinestatic

Compute the normal (non unitary) of the plane defined by the three points.

Definition at line 130 of file AIFPropertiesHelpers.h.

Here is the caller graph for this function:

◆ compute_unit_normal() [1/2]

template<typename mesh >

static Vector FEVV::DataStructures::AIF::AIFPropertiesHelpers::compute_unit_normal	(	const mesh	m,
		const vertex_descriptor	v1,
		const vertex_descriptor	v2,
		const vertex_descriptor	v3
	)

inlinestatic

Compute the unit normal of the plane defined by the three vertices.

Definition at line 190 of file AIFPropertiesHelpers.h.

Here is the call graph for this function:

◆ compute_unit_normal() [2/2]

static Vector FEVV::DataStructures::AIF::AIFPropertiesHelpers::compute_unit_normal	(	const Point &	p1,
		const Point &	p2,
		const Point &	p3
	)

inlinestatic

Compute the unit normal of the plane defined by the three points.

Definition at line 170 of file AIFPropertiesHelpers.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_point() [1/3]

static Point& FEVV::DataStructures::AIF::AIFPropertiesHelpers::get_point	(	const ptr_mesh	m,
		vertex_descriptor	v
	)

inlinestatic

Get the vertex coordinates.

Parameters

m	mesh
v	vertex descriptor

Returns: the point that contain the vertex coordinates

Definition at line 100 of file AIFPropertiesHelpers.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_point() [2/3]

static Point& FEVV::DataStructures::AIF::AIFPropertiesHelpers::get_point	(	const smart_ptr_mesh	m,
		vertex_descriptor	v
	)

inlinestatic

Get the vertex coordinates.

Parameters

m	mesh
v	vertex descriptor

Returns: the point that contain the vertex coordinates

Definition at line 110 of file AIFPropertiesHelpers.h.

Here is the call graph for this function:

◆ get_point() [3/3]

static Point& FEVV::DataStructures::AIF::AIFPropertiesHelpers::get_point	(	ref_mesh	m,
		vertex_descriptor	v
	)

inlinestatic

Get the vertex coordinates.

Parameters

m	mesh
v	vertex descriptor

Returns: the point that contain the vertex coordinates

Definition at line 120 of file AIFPropertiesHelpers.h.

Here is the call graph for this function:

◆ length()

template<typename mesh >

static CoordinateType FEVV::DataStructures::AIF::AIFPropertiesHelpers::length	(	const mesh	m,
		const edge_descriptor	e
	)

inlinestatic

Compute the length of an edge.

Definition at line 205 of file AIFPropertiesHelpers.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set_point() [1/3]

static void FEVV::DataStructures::AIF::AIFPropertiesHelpers::set_point	(	const ptr_mesh	m,
		vertex_descriptor	v,
		CoordinateType	x,
		CoordinateType	y,
		CoordinateType	z
	)

inlinestatic

Set the vertex coordinates.

Parameters

m	mesh
v	vertex descriptor
x	x coordinate
y	y coordinate
z	z coordinate

Definition at line 49 of file AIFPropertiesHelpers.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set_point() [2/3]

static void FEVV::DataStructures::AIF::AIFPropertiesHelpers::set_point	(	const smart_ptr_mesh	m,
		vertex_descriptor	v,
		CoordinateType	x,
		CoordinateType	y,
		CoordinateType	z
	)

inlinestatic

Set the vertex coordinates.

Parameters

m	mesh
v	vertex descriptor
x	x coordinate
y	y coordinate
z	z coordinate

Definition at line 67 of file AIFPropertiesHelpers.h.

Here is the call graph for this function:

◆ set_point() [3/3]

static void FEVV::DataStructures::AIF::AIFPropertiesHelpers::set_point	(	ref_mesh	m,
		vertex_descriptor	v,
		CoordinateType	x,
		CoordinateType	y,
		CoordinateType	z
	)

inlinestatic

Set the vertex coordinates.

Parameters

m	mesh
v	vertex descriptor
x	x coordinate
y	y coordinate
z	z coordinate

Definition at line 84 of file AIFPropertiesHelpers.h.

Here is the call graph for this function:

The documentation for this class was generated from the following file:

/Users/mac/builds/efd823a3/0/MEPP-team/MEPP2/FEVV/DataStructures/AIF/AIFPropertiesHelpers.h

Public Types

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ AIFMesh

◆ CoordinateType

◆ edge_descriptor

◆ NormalCoordinateType

◆ Point

◆ ptr_mesh

◆ ref_mesh

◆ smart_ptr_mesh

◆ Vector

◆ vertex_descriptor

Member Function Documentation

◆ compute_normal() [1/2]

◆ compute_normal() [2/2]

◆ compute_unit_normal() [1/2]

◆ compute_unit_normal() [2/2]

◆ get_point() [1/3]

◆ get_point() [2/3]

◆ get_point() [3/3]

◆ length()

◆ set_point() [1/3]

◆ set_point() [2/3]

◆ set_point() [3/3]