#include <Clip.hpp>

Inheritance diagram for mgx::Clip:

Public Member Functions
	Clip (int id, QObject *parent=0)

int	clipNo () const

void	enable ()

void	disable ()

bool	enabled () const

void	showGrid ()

void	hideGrid ()

bool	grid () const
	Returns true if the grid is sto be shown, false otherwise. More...

void	setWidth (float f)

float	width () const

void	setGridSize (float s)

float	gridSize () const

void	setNormal (const Point3f &n)

const Point3f &	normal () const

Point4f	normalFormPos () const
	Return the description of the clipping plane as a 4d point, as used by OpenGL This one returns the positive plane (i.e. More...

Point4f	normalFormNeg () const
	Return the description of the clipping plane as a 4d point, as used by OpenGL This one returns the negative plane (i.e. More...

void	setGridSquares (uint n)

uint	gridSquares () const

qglviewer::ManipulatedFrame &	frame ()
	Get frame. More...

const qglviewer::ManipulatedFrame &	frame () const

void	hasChanged ()
	Call this if you change the manipulated frame. More...

bool	changed () const

void	resetChanges ()

bool	isClipped (const Point3f &p)

const Point3f &	xb () const

const Point3f &	yb () const

const Point3f &	zb () const

Protected Member Functions
void	computeBasis ()

Protected Attributes
bool	_enable
	If true, these planes are used to clipping. More...

bool	_showGrid
	Show the grid corresponding to the clipping plane. More...

float	_width
	Width of the region. More...

float	_gridSize
	Size of the grid (i.e. in the clipping plane) More...

Point3f	_normal
	Normal to the grid. More...

Point3f	_xb
	X-axis of the planes. More...

Point3f	_yb
	Y-axis of the planes. More...

Point3f	_zb
	Thickness of the region. More...

uint	_gridSquares
	Number of squares drawn for the grid. More...

int	_clipNo
	Id of the clipping region (0, 1 or 2) More...

bool	_changed
	If true, it changed and need update in OpenGL. More...

qglviewer::ManipulatedFrame	_frame

Detailed Description

Definition at line 20 of file Clip.hpp.

Constructor & Destructor Documentation

◆ Clip()

mgx::Clip::Clip	(	int	id,
		QObject *	parent = `0`
	)

Member Function Documentation

◆ changed()

bool mgx::Clip::changed ( ) const

inline

Definition at line 141 of file Clip.hpp.

◆ clipNo()

int mgx::Clip::clipNo ( ) const

inline

Definition at line 27 of file Clip.hpp.

◆ computeBasis()

void mgx::Clip::computeBasis ( )

protected

◆ disable()

void mgx::Clip::disable ( )

inline

Definition at line 38 of file Clip.hpp.

◆ enable()

void mgx::Clip::enable ( )

inline

Definition at line 31 of file Clip.hpp.

◆ enabled()

bool mgx::Clip::enabled ( ) const

inline

Definition at line 45 of file Clip.hpp.

◆ frame() [1/2]

qglviewer::ManipulatedFrame& mgx::Clip::frame ( )

inline

Get frame.

Definition at line 127 of file Clip.hpp.

◆ frame() [2/2]

const qglviewer::ManipulatedFrame& mgx::Clip::frame ( ) const

inline

Definition at line 130 of file Clip.hpp.

◆ grid()

bool mgx::Clip::grid ( ) const

inline

Returns true if the grid is sto be shown, false otherwise.

Definition at line 66 of file Clip.hpp.

◆ gridSize()

float mgx::Clip::gridSize ( ) const

inline

Definition at line 88 of file Clip.hpp.

◆ gridSquares()

uint mgx::Clip::gridSquares ( ) const

inline

Definition at line 122 of file Clip.hpp.

◆ hasChanged()

void mgx::Clip::hasChanged ( )

inline

Call this if you change the manipulated frame.

Definition at line 137 of file Clip.hpp.

◆ hideGrid()

void mgx::Clip::hideGrid ( )

inline

Definition at line 56 of file Clip.hpp.

◆ isClipped()

bool mgx::Clip::isClipped ( const Point3f & p )

◆ normal()

const Point3f& mgx::Clip::normal ( ) const

inline

Definition at line 100 of file Clip.hpp.

◆ normalFormNeg()

Point4f mgx::Clip::normalFormNeg ( ) const

Return the description of the clipping plane as a 4d point, as used by OpenGL This one returns the negative plane (i.e.

the one with negative normal)

◆ normalFormPos()

Point4f mgx::Clip::normalFormPos ( ) const

Return the description of the clipping plane as a 4d point, as used by OpenGL This one returns the positive plane (i.e.

the one with positive normal)

◆ resetChanges()

void mgx::Clip::resetChanges ( )

inline

Definition at line 144 of file Clip.hpp.

◆ setGridSize()

void mgx::Clip::setGridSize ( float s )

inline

Definition at line 81 of file Clip.hpp.

◆ setGridSquares()

void mgx::Clip::setGridSquares ( uint n )

inline

Definition at line 115 of file Clip.hpp.

◆ setNormal()

void mgx::Clip::setNormal ( const Point3f & n )

inline

Definition at line 92 of file Clip.hpp.

◆ setWidth()

void mgx::Clip::setWidth ( float f )

inline

Definition at line 70 of file Clip.hpp.

◆ showGrid()

void mgx::Clip::showGrid ( )

inline

Definition at line 49 of file Clip.hpp.

◆ width()

float mgx::Clip::width ( ) const

inline

Definition at line 77 of file Clip.hpp.

◆ xb()

const Point3f& mgx::Clip::xb ( ) const

inline

Definition at line 150 of file Clip.hpp.

◆ yb()

const Point3f& mgx::Clip::yb ( ) const

inline

Definition at line 153 of file Clip.hpp.

◆ zb()

const Point3f& mgx::Clip::zb ( ) const

inline

Definition at line 156 of file Clip.hpp.

Member Data Documentation

◆ _changed

bool mgx::Clip::_changed

protected

If true, it changed and need update in OpenGL.

Definition at line 173 of file Clip.hpp.

◆ _clipNo

int mgx::Clip::_clipNo

protected

Id of the clipping region (0, 1 or 2)

Definition at line 172 of file Clip.hpp.

◆ _enable

bool mgx::Clip::_enable

protected

If true, these planes are used to clipping.

Definition at line 163 of file Clip.hpp.

◆ _frame

qglviewer::ManipulatedFrame mgx::Clip::_frame

protected

Definition at line 174 of file Clip.hpp.

◆ _gridSize

float mgx::Clip::_gridSize

protected

Size of the grid (i.e. in the clipping plane)

Definition at line 166 of file Clip.hpp.

◆ _gridSquares

uint mgx::Clip::_gridSquares

protected

Number of squares drawn for the grid.

Definition at line 171 of file Clip.hpp.

◆ _normal

Point3f mgx::Clip::_normal

protected

Normal to the grid.

Definition at line 167 of file Clip.hpp.

◆ _showGrid

bool mgx::Clip::_showGrid

protected

Show the grid corresponding to the clipping plane.

Definition at line 164 of file Clip.hpp.

◆ _width

float mgx::Clip::_width

protected

Width of the region.

Definition at line 165 of file Clip.hpp.

◆ _xb

Point3f mgx::Clip::_xb

protected

X-axis of the planes.

Definition at line 168 of file Clip.hpp.

◆ _yb

Point3f mgx::Clip::_yb

protected

Y-axis of the planes.

Definition at line 169 of file Clip.hpp.

◆ _zb

Point3f mgx::Clip::_zb

protected

Thickness of the region.

Definition at line 170 of file Clip.hpp.

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

src/Clip.hpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Clip()

Member Function Documentation

◆ changed()

◆ clipNo()

◆ computeBasis()

◆ disable()

◆ enable()

◆ enabled()

◆ frame() [1/2]

◆ frame() [2/2]

◆ grid()

◆ gridSize()

◆ gridSquares()

◆ hasChanged()

◆ hideGrid()

◆ isClipped()

◆ normal()

◆ normalFormNeg()

◆ normalFormPos()

◆ resetChanges()

◆ setGridSize()

◆ setGridSquares()

◆ setNormal()

◆ setWidth()

◆ showGrid()

◆ width()

◆ xb()

◆ yb()

◆ zb()

Member Data Documentation

◆ _changed

◆ _clipNo

◆ _enable

◆ _frame

◆ _gridSize

◆ _gridSquares

◆ _normal

◆ _showGrid

◆ _width

◆ _xb

◆ _yb

◆ _zb