A box representing a region of interest. More...

#include <WROIBox.h>

Inheritance diagram for WROIBox:

Classes
class	ROIBoxNodeCallback
	Node callback to handle updates properly. More...
Public Member Functions
	WROIBox (WPosition minPos, WPosition maxPos)
	Yields box with desired extremal points minPos and maxPos.
WPosition	getMinPos () const
	Get the corner of the box that has minimal x, y and z values.
WPosition	getMaxPos () const
	Get the corner of the box that has maximal x, y and z values.
WPropPosition	getMinPosProperty ()
	Get the corner of the box that has minimal x, y and z values.
WPropPosition	getMaxPosProperty ()
	Get the corner of the box that has maximal x, y and z values.
void	setColor (osg::Vec4 color)
	Setter for standard color.
void	setNotColor (osg::Vec4 color)
	Setter for color in negated state.
Private Member Functions
void	registerRedrawRequest (WPickInfo pickInfo)
	note that there was a pick
virtual void	updateGFX ()
	updates the graphics
void	boxPropertiesChanged (boost::shared_ptr< WPropertyBase > property)
	Called when the specified property has changed.
void	updateColor (osg::Vec4 color)
	Set new color of the box in the geometry.
Private Attributes
size_t	boxId
	Id of the current box.
WPropGroup	m_propGrp
	Group for box specific props.
WPropPosition	m_minPos
	The minimum position of the box.
WPropPosition	m_maxPos
	The maximum position of the box.
WGEShader::RefPtr	m_lightShader
	Shader for proper lighting.
bool	m_needVertexUpdate
	If true, the box' vertex data is updated.
bool	m_isPicked
	Indicates whether the box is currently picked or not.
WPosition	m_pickedPosition
	Caches the old picked position to a allow for cmoparison.
WVector3d	m_pickNormal
	Store the normal that occured when the pick action was started.
WVector2d	m_oldPixelPosition
	Caches the old picked position to a allow for cmoparison.
int16_t	m_oldScrollWheel
	caches scroll wheel value
boost::shared_mutex	m_updateLock
	Lock to prevent concurrent threads trying to update the osg node.
osg::ref_ptr< osg::Geometry >	m_surfaceGeometry
	store this pointer for use in updates
WPickInfo	m_pickInfo
	Stores the pick information for potential redraw.
boost::shared_ptr< WGEViewer >	m_viewer
	makes viewer available all over this class.
osg::Vec4	m_color
	the color of the box
osg::Vec4	m_notColor
	the color of the box when negated
Static Private Attributes
static size_t	maxBoxId = 0
	Current maximum boxId over all boxes.

Detailed Description

A box representing a region of interest.

Definition at line 45 of file WROIBox.h.

Constructor & Destructor Documentation

WROIBox::WROIBox	(	WPosition	minPos,
		WPosition	maxPos
	)

Yields box with desired extremal points minPos and maxPos.

Parameters:

minPos	Left, lower, front corner. Minimal x, y and z coordinates.
maxPos	Right, upper, back corner. Maximal x, y and z coordinates.

Definition at line 43 of file WROIBox.cpp.

References boxId, boxPropertiesChanged(), WGraphicsEngine::getGraphicsEngine(), m_lightShader, m_maxPos, m_minPos, m_needVertexUpdate, WROI::m_not, WROI::m_pickHandler, WROI::m_properties, m_propGrp, m_viewer, registerRedrawRequest(), and WROI::setDirty().

Member Function Documentation

void WROIBox::boxPropertiesChanged ( boost::shared_ptr< WPropertyBase > property ) [private]

Called when the specified property has changed.

Used to update the ROI when modifying box properties.

Parameters:

property the property

Definition at line 133 of file WROIBox.cpp.

References m_needVertexUpdate.

Referenced by WROIBox().

WPosition WROIBox::getMaxPos ( ) const

Get the corner of the box that has maximal x, y and z values.

Returns:: the corner position

Definition at line 108 of file WROIBox.cpp.

References m_maxPos.

Referenced by updateGFX().

WPropPosition WROIBox::getMaxPosProperty ( )

Get the corner of the box that has maximal x, y and z values.

Returns:: the corner position

Definition at line 118 of file WROIBox.cpp.

References m_maxPos.

WPosition WROIBox::getMinPos ( ) const

Get the corner of the box that has minimal x, y and z values.

Returns:: the corner position

Definition at line 103 of file WROIBox.cpp.

References m_minPos.

Referenced by updateGFX().

WPropPosition WROIBox::getMinPosProperty ( )

Get the corner of the box that has minimal x, y and z values.

Returns:: the corner position

Definition at line 113 of file WROIBox.cpp.

References m_minPos.

void WROIBox::registerRedrawRequest ( WPickInfo pickInfo ) [private]

note that there was a pick

Parameters:

pickInfo info from pick

Definition at line 123 of file WROIBox.cpp.

References m_pickInfo, and m_updateLock.

Referenced by WROIBox().

void WROIBox::setColor ( osg::Vec4 color )

Setter for standard color.

Parameters:

color The new color.

Definition at line 285 of file WROIBox.cpp.

References m_color.

void WROIBox::setNotColor ( osg::Vec4 color )

Setter for color in negated state.

Parameters:

color The new color.

Definition at line 290 of file WROIBox.cpp.

References m_notColor.

void WROIBox::updateColor ( osg::Vec4 color ) [private]

Set new color of the box in the geometry.

Parameters:

color the new color

Definition at line 295 of file WROIBox.cpp.

References m_surfaceGeometry.

Referenced by updateGFX().

void WROIBox::updateGFX ( ) [private, virtual]

updates the graphics

Implements WROI.

Definition at line 138 of file WROIBox.cpp.

References boxId, wge::createCube(), getMaxPos(), getMinPos(), WPickInfo::getModifierKey(), WPickInfo::getName(), WPickInfo::getPickNormal(), WPickInfo::getPickPixel(), WPickInfo::getScrollWheel(), m_color, WROI::m_dirty, m_isPicked, m_maxPos, m_minPos, m_needVertexUpdate, WROI::m_not, m_notColor, m_oldPixelPosition, m_oldScrollWheel, m_pickInfo, m_pickNormal, m_surfaceGeometry, m_updateLock, m_viewer, WROI::setDirty(), wge::unprojectFromScreen(), updateColor(), WMatrixFixed< ValueT, Rows, Cols, ValueStoreT >::x(), and WMatrixFixed< ValueT, Rows, Cols, ValueStoreT >::y().

Referenced by WROIBox::ROIBoxNodeCallback::operator()().

Member Data Documentation

size_t WROIBox::boxId [private]

Id of the current box.

Definition at line 100 of file WROIBox.h.

Referenced by updateGFX(), and WROIBox().

osg::Vec4 WROIBox::m_color [private]

the color of the box

Reimplemented from WROI.

Definition at line 130 of file WROIBox.h.

Referenced by setColor(), and updateGFX().

bool WROIBox::m_isPicked [private]

Indicates whether the box is currently picked or not.

Definition at line 118 of file WROIBox.h.

Referenced by updateGFX().

WGEShader::RefPtr WROIBox::m_lightShader [private]

Shader for proper lighting.

Definition at line 112 of file WROIBox.h.

Referenced by WROIBox().

WPropPosition WROIBox::m_maxPos [private]

The maximum position of the box.

Definition at line 107 of file WROIBox.h.

Referenced by getMaxPos(), getMaxPosProperty(), updateGFX(), and WROIBox().

WPropPosition WROIBox::m_minPos [private]

The minimum position of the box.

Definition at line 106 of file WROIBox.h.

Referenced by getMinPos(), getMinPosProperty(), updateGFX(), and WROIBox().

bool WROIBox::m_needVertexUpdate [private]

If true, the box' vertex data is updated.

Definition at line 117 of file WROIBox.h.

Referenced by boxPropertiesChanged(), updateGFX(), and WROIBox().

osg::Vec4 WROIBox::m_notColor [private]

the color of the box when negated

Definition at line 132 of file WROIBox.h.

Referenced by setNotColor(), and updateGFX().

WVector2d WROIBox::m_oldPixelPosition [private]

Caches the old picked position to a allow for cmoparison.

Definition at line 121 of file WROIBox.h.

Referenced by updateGFX().

int16_t WROIBox::m_oldScrollWheel [private]

caches scroll wheel value

Definition at line 122 of file WROIBox.h.

Referenced by updateGFX().

WPosition WROIBox::m_pickedPosition [private]

Caches the old picked position to a allow for cmoparison.

Definition at line 119 of file WROIBox.h.

WPickInfo WROIBox::m_pickInfo [private]

Stores the pick information for potential redraw.

Definition at line 126 of file WROIBox.h.

Referenced by registerRedrawRequest(), and updateGFX().

WVector3d WROIBox::m_pickNormal [private]

Store the normal that occured when the pick action was started.

Definition at line 120 of file WROIBox.h.

Referenced by updateGFX().

WPropGroup WROIBox::m_propGrp [private]

Group for box specific props.

Definition at line 105 of file WROIBox.h.

Referenced by WROIBox().

osg::ref_ptr< osg::Geometry > WROIBox::m_surfaceGeometry [private]

store this pointer for use in updates

Definition at line 124 of file WROIBox.h.

Referenced by updateColor(), and updateGFX().

boost::shared_mutex WROIBox::m_updateLock [private]

Lock to prevent concurrent threads trying to update the osg node.

Definition at line 123 of file WROIBox.h.

Referenced by registerRedrawRequest(), and updateGFX().

boost::shared_ptr< WGEViewer > WROIBox::m_viewer [private]

makes viewer available all over this class.

Definition at line 128 of file WROIBox.h.

Referenced by updateGFX(), and WROIBox().

size_t WROIBox::maxBoxId = 0 [static, private]

Current maximum boxId over all boxes.

Definition at line 99 of file WROIBox.h.

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

Classes

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation