Ocean::Geometry::Quadric Class Reference

This class implements the base for all quadric object. More...

Inheritance diagram for Ocean::Geometry::Quadric:

Public Member Functions
	Quadric ()
	Creates an invalid quadric. More...
bool	isInside (const Vector3 &point) const
	Returns whether a given point lies inside or on the surface of the cone. More...
bool	isOnSurface (const Vector3 &point) const
	Returns whether a given point lies on the surface of the cone. More...
Scalar	value (const Vector3 &point) const
	Returns the quadric value for a given point. More...

Protected Member Functions
void	createCombinedQuadric (const SquareMatrix4 &quadric, const HomogenousMatrix4 &transformation)
	Creates the combination of quadric and transformation matrix. More...

Protected Attributes
SquareMatrix4	combinedQuadric
	Holds the combined quadric and transformation matrix. More...

Detailed Description

This class implements the base for all quadric object.

Constructor & Destructor Documentation

Quadric()

Ocean::Geometry::Quadric::Quadric

(

)

Creates an invalid quadric.

Member Function Documentation

createCombinedQuadric()

void Ocean::Geometry::Quadric::createCombinedQuadric ( const SquareMatrix4 &  quadric, const HomogenousMatrix4 &  transformation  )

protected

Creates the combination of quadric and transformation matrix.

Parameters

quadric	Quadric matrix
transformation	Transformation matrix to be combined with the quadric

isInside()

bool Ocean::Geometry::Quadric::isInside

(

const Vector3 &

point

)

const

Returns whether a given point lies inside or on the surface of the cone.

Parameters

point

Point to check

Returns

True, if so

isOnSurface()

bool Ocean::Geometry::Quadric::isOnSurface

(

const Vector3 &

point

)

const

Returns whether a given point lies on the surface of the cone.

Parameters

point

Point to check

Returns

True, if so

value()

Scalar Ocean::Geometry::Quadric::value

(

const Vector3 &

point

)

const

Returns the quadric value for a given point.

Parameters

point

Point to check

Returns

Quadric value

Field Documentation

combinedQuadric

SquareMatrix4 Ocean::Geometry::Quadric::combinedQuadric

protected

Holds the combined quadric and transformation matrix.

---

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

• Quadric.h