Class flat

Inheritance Relationships

Base Type

  • public plane

Class Documentation

class enve::ground::flat : public plane

Triangular flat class.

Public Functions

flat(flat const&) = delete

Flat copy constructor.

flat(flat&&) = delete

Flat move constructor.

flat &operator=(const flat&) = delete

Flat assignment operator.

flat &operator=(flat&&) = delete

Flat move assignment operator.

~flat(void) override = default

Flat class destructor.

flat(void)

Flat class constructor.

flat(real friction, real origin_x, real origin_y, real origin_z, real normal_x, real normal_y, real normal_z)

Flat class constructor.

Parameters
  • friction – Friction coefficient scaling factor

  • origin_x – Input x value of ground plane origin point

  • origin_y – Input y value of ground plane origin point

  • origin_z – Input z value of ground plane origin point

  • normal_x – Input x value of ground plane normal vector

  • normal_y – Input y value of ground plane normal vector

  • normal_z – Input z value of ground plane normal vector

flat(real friction, point const &origin, vec3 const &normal)

Flat class constructor.

Parameters
  • friction – Friction coefficient scaling factor

  • origin – Input plane origin point

  • normal – Input plane normal vector

flat(real friction, plane const &plane_obj)

Flat class constructor.

Parameters
  • friction – Friction coefficient scaling factor

  • plane_obj – Input flat object

void copy(flat const &flat_obj)

Copy flat object.

Parameters

flat_obj – Flat object to be copied

bool isApprox(flat const &flat_obj, real tolerance = EPSILON_LOW) const

Check if objects are (almost) equal.

Parameters
  • flat_obj – Input flat object

  • tolerance – Tolerance

real const &friction(void) const

Get friction coefficent scaling factor const reference.

real &friction(void)

Set friction coefficent scaling factor reference.

plane const &layingPlane(void) const

Get laying plane.

plane &layingPlane(void)

Set laying plane.

void print(out_stream &os) const

Print data.

Parameters

os – Output stream