OCCViewer_ClipPlane Class Reference

#include <OCCViewer_ClipPlane.h>

Public Types
enum	PlaneMode { Absolute , Relative }
enum	AbsoluteOrientationType { AbsoluteCustom , AbsoluteXY , AbsoluteYZ , AbsoluteZX }
enum	RelativeOrientationType { RelativeXY , RelativeYZ , RelativeZX }

Public Member Functions
	OCCViewer_ClipPlane ()
OCCViewer_ClipPlane &	operator= (const OCCViewer_ClipPlane &theOther)
void	OrientationToXYZ (double &theDx, double &theDy, double &theDz) const

Static Public Member Functions
static void	DXYZToRelative (const double theDx, const double theDy, const double theDz, const int theRelativeType, double &theRotation1, double &theRotation2)
static void	RelativeToDXYZ (const int theRelativeType, const double theRotation1, const double theRotation2, double &theDx, double &theDy, double &theDz)

Public Attributes
PlaneMode	Mode
bool	IsOn
double	X
double	Y
double	Z
int	OrientationType
union {
struct {
bool   IsInvert
double   Dx
double   Dy
double   Dz
}   AbsoluteOrientation
struct {
double   Rotation1
double   Rotation2
}   RelativeOrientation
};

Detailed Description

Definition of OCC viewer clipping plane.

Member Enumeration Documentation

AbsoluteOrientationType

enum OCCViewer_ClipPlane::AbsoluteOrientationType

Enumerator
AbsoluteCustom
AbsoluteXY
AbsoluteYZ
AbsoluteZX

PlaneMode

enum OCCViewer_ClipPlane::PlaneMode

Enumerator
Absolute
Relative

RelativeOrientationType

enum OCCViewer_ClipPlane::RelativeOrientationType

Enumerator
RelativeXY
RelativeYZ
RelativeZX

Constructor & Destructor Documentation

OCCViewer_ClipPlane()

OCCViewer_ClipPlane::OCCViewer_ClipPlane

(

)

References AbsoluteCustom, AbsoluteOrientation, and OrientationType.

Member Function Documentation

DXYZToRelative()

void OCCViewer_ClipPlane::DXYZToRelative ( const double  theDx, const double  theDy, const double  theDz, const int  theOrientationType, double &  theRotation1, double &  theRotation2  )

static

Converts normal direction to relative definition.

Parameters

theDx	[in] the direction x component.
theDy	[in] the direction y component.
theDz	[in] the direction y component.
theRelativeType	[in] the relative orientation type.
theRotation1	[out] the angle of rotation around first axis.
theRotation2	[out] the angle of rotation around second axis.

References RelativeXY, RelativeYZ, and RelativeZX.

operator=()

OCCViewer_ClipPlane & OCCViewer_ClipPlane::operator=

(

const OCCViewer_ClipPlane &

theOther

)

Operator of another OCCViewer_ClipPlane assignment.

Parameters

theOther

the OCCViewer_ClipPlane to assign.

Returns

the assigned OCCViewer_ClipPlane.

References Absolute, AbsoluteOrientation, IsOn, Mode, OrientationType, Relative, RelativeOrientation, X, Y, and Z.

OrientationToXYZ()

void OCCViewer_ClipPlane::OrientationToXYZ	(	double &	theDx,
		double &	theDy,
		double &	theDz
	)		const

Converts defined orientation to direction.

Parameters

theDx	[out] the direction x component.
theDy	[out] the direction y component.
theDz	[out] the direction y component.

References Absolute, AbsoluteCustom, AbsoluteOrientation, AbsoluteXY, AbsoluteYZ, AbsoluteZX, Mode, OrientationType, RelativeOrientation, and RelativeToDXYZ().

RelativeToDXYZ()

void OCCViewer_ClipPlane::RelativeToDXYZ ( const int  theOrientationType, const double  theRotation1, const double  theRotation2, double &  theDx, double &  theDy, double &  theDz  )

static

Converts normal direction to relative definition.

Parameters

theDx	[in] the direction x component.
theDy	[in] the direction y component.
theDz	[in] the direction y component.
theRelativeType	[in] the relative orientation type.
theRotation1	[out] the angle of rotation around first axis.
theRotation2	[out] the angle of rotation around second axis.

References Plot2d::Cross, RelativeXY, RelativeYZ, and RelativeZX.

Member Data Documentation

union { ... }

struct { ... } OCCViewer_ClipPlane::AbsoluteOrientation

Dx

double OCCViewer_ClipPlane::Dx

Dy

double OCCViewer_ClipPlane::Dy

Dz

double OCCViewer_ClipPlane::Dz

IsInvert

bool OCCViewer_ClipPlane::IsInvert

IsOn

bool OCCViewer_ClipPlane::IsOn

Mode

PlaneMode OCCViewer_ClipPlane::Mode

OrientationType

int OCCViewer_ClipPlane::OrientationType

struct { ... } OCCViewer_ClipPlane::RelativeOrientation

Rotation1

double OCCViewer_ClipPlane::Rotation1

Rotation2

double OCCViewer_ClipPlane::Rotation2

X

double OCCViewer_ClipPlane::X

Y

double OCCViewer_ClipPlane::Y

Z

double OCCViewer_ClipPlane::Z

---

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

• src/OCCViewer/OCCViewer_ClipPlane.h
• src/OCCViewer/OCCViewer_ClipPlane.cxx