Open Inventor Reference
SbPlaned Class Reference

Oriented plane in 3D with double values. More...

#include <Inventor/SbLineard.h>

Public Member Functions

 SbPlaned ()
 Default constructor.
 
 SbPlaned (const SbVec3d &p0, const SbVec3d &p1, const SbVec3d &p2)
 Construct a plane given three points.
 
 SbPlaned (const SbVec3d &n, double d)
 Construct a plane given normal and distance from origin along normal.
 
 SbPlaned (const SbVec3d &n, const SbVec3d &p)
 Construct a plane given normal and a point to pass through Orientation is given by the normal vector n.
 
void offset (double d)
 Offset a plane by a given distance.
 
bool intersect (const SbLined &l, SbVec3d &intersection) const
 Intersect line and plane, returning TRUE if there is an intersection, FALSE if line is parallel to plane.
 
void transform (const SbMatrixd &matrix)
 Transforms the plane by the given matrix.
 
bool isInHalfSpace (const SbVec3d &point) const
 Returns TRUE if the given point is within the half-space defined by the plane.
 
double getDistance (const SbVec3d &point) const
 Returns the distance of the point to the plane.
 
const SbVec3dgetNormal () const
 Returns normal vector to plane.
 
double getDistanceFromOrigin () const
 Returns distance from origin to plane.
 

Friends

INVENTOR_API bool operator== (const SbPlaned &p1, const SbPlaned &p2)
 Equality/inequality comparison operators.
 
INVENTOR_API bool operator!= (const SbPlaned &p1, const SbPlaned &p2)
 

Detailed Description

Represents an oriented plane in 3D. This is a lightweight class/datatype that is used for arguments to some Inventor objects. {}

See Also
SbVec3f, SbLine, SbPlane, SbVec3d, SbLined

Definition at line 920 of file SbLineard.h.

Constructor & Destructor Documentation

◆ SbPlaned() [1/4]

SbPlaned::SbPlaned ( )
inline

Definition at line 923 of file SbLineard.h.

Referenced by operator!=, and operator==.

◆ SbPlaned() [2/4]

SbPlaned::SbPlaned ( const SbVec3d & p0,
const SbVec3d & p1,
const SbVec3d & p2 )

p0, p1, and p2 represent three points in the plane.

◆ SbPlaned() [3/4]

SbPlaned::SbPlaned ( const SbVec3d & n,
double d )

Orientation is given by the normal vector n.

◆ SbPlaned() [4/4]

SbPlaned::SbPlaned ( const SbVec3d & n,
const SbVec3d & p )

Member Function Documentation

◆ getDistance()

double SbPlaned::getDistance ( const SbVec3d & point) const

◆ getDistanceFromOrigin()

double SbPlaned::getDistanceFromOrigin ( ) const
inline

Definition at line 958 of file SbLineard.h.

◆ getNormal()

const SbVec3d & SbPlaned::getNormal ( ) const
inline

Definition at line 956 of file SbLineard.h.

◆ intersect()

bool SbPlaned::intersect ( const SbLined & l,
SbVec3d & intersection ) const

◆ isInHalfSpace()

bool SbPlaned::isInHalfSpace ( const SbVec3d & point) const

◆ offset()

void SbPlaned::offset ( double d)

◆ transform()

void SbPlaned::transform ( const SbMatrixd & matrix)

Friends And Related Symbol Documentation

◆ operator!=

INVENTOR_API bool operator!= ( const SbPlaned & p1,
const SbPlaned & p2 )
friend

Definition at line 975 of file SbLineard.h.

References INVENTOR_API, and SbPlaned().

◆ operator==

INVENTOR_API bool operator== ( const SbPlaned & p1,
const SbPlaned & p2 )
friend

References INVENTOR_API, and SbPlaned().


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