Raytrix Light Field SDK  v3.0
Logo
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events Groups Pages
CLUViz::Net::ViewToolBase Class Referenceabstract

Detailed Description

Base implementation of CluViz view tools.

This class provides base features to load a certain view tool script into a given CluViz view control and provides capabilities to draw objects into loaded the script.

Inherited by CLUViz::Net::View3dTool, CLUViz::Net::ViewImageDepth3dTool, and CLUViz::Net::ViewImageTool.

Public Member Functions

 ViewToolBase ()
 Default constructor. More...
 
 ViewToolBase (ViewCtrl^ xViewCtrl)
 Constructor that attaches to the given view control. See AttachTo. More...
 
void AttachTo (ViewCtrl^ xViewCtrl)
 Attaches to the given view control. Detaches from last view control by calling Detach. Loads the provided tool script. More...
 
void Detach ()
 Detaches this ViewToolBase from the last view control. This resets the loaded script and makes this class invalid. More...
 

Protected Member Functions

virtual ~ViewToolBase ()
 Destructor More...
 
virtual void _LoadToolScript ()=0
 Loads the provided tool script. You have to override this method in your derived implementation. More...
 

Protected Attributes

Rx::Net::StdVboMoniker^ m_xObject
 The standard VBO moniker More...
 
ViewCtrlm_xViewCtrl
 The view control More...
 

Properties

int CircleEdgeCount
 Gets or sets the number of edges that describes a circle. The higher the number the slower the drawing. Default: 32. More...
 
bool IsValid [get]
 Gets a value indicating whether this ViewToolBase is valid. This base is valid if ViewToolBase or AttachTo has been called with a valid reference to a ViewCtrl. More...
 
ViewCtrl^  ViewControl [get]
 Gets the view control that has this ViewToolBase attached. More...
 

Constructor & Destructor Documentation

CLUViz::Net::ViewToolBase::ViewToolBase ( )

Default constructor.

To make the instance valid, you have to call AttachTo with a valid reference to a view control.

CLUViz::Net::ViewToolBase::ViewToolBase ( ViewCtrl xViewCtrl)

Constructor that attaches to the given view control. See AttachTo.

Parameters
xViewCtrl[in] The view control to attach to.
virtual CLUViz::Net::ViewToolBase::~ViewToolBase ( )
protectedvirtual

Destructor

Member Function Documentation

virtual void CLUViz::Net::ViewToolBase::_LoadToolScript ( )
protectedpure virtual

Loads the provided tool script. You have to override this method in your derived implementation.

Implemented in CLUViz::Net::View3dTool, CLUViz::Net::ViewImageTool, and CLUViz::Net::ViewImageDepth3dTool.

void CLUViz::Net::ViewToolBase::AttachTo ( ViewCtrl xViewCtrl)

Attaches to the given view control. Detaches from last view control by calling Detach. Loads the provided tool script.

Parameters
xViewCtrl[in] The view control.
void CLUViz::Net::ViewToolBase::Detach ( )

Detaches this ViewToolBase from the last view control. This resets the loaded script and makes this class invalid.

Member Data Documentation

Rx::Net::StdVboMoniker ^ CLUViz::Net::ViewToolBase::m_xObject
protected

The standard VBO moniker

ViewCtrl ^ CLUViz::Net::ViewToolBase::m_xViewCtrl
protected

The view control

Property Documentation

int CLUViz::Net::ViewToolBase::CircleEdgeCount

Gets or sets the number of edges that describes a circle. The higher the number the slower the drawing. Default: 32.

bool CLUViz::Net::ViewToolBase::IsValid
get

Gets a value indicating whether this ViewToolBase is valid. This base is valid if ViewToolBase or AttachTo has been called with a valid reference to a ViewCtrl.

ViewCtrl^ CLUViz::Net::ViewToolBase::ViewControl
get

Gets the view control that has this ViewToolBase attached.