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

Detailed Description

A view 3D tool.

Inherits CLUViz::Net::ViewToolBase.

Public Member Functions

 View3dTool ()
 Default constructor. More...
 
 View3dTool (ViewCtrl^ xViewCtrl)
 Constructor that attaches to the given view control. See AttachTo. More...
 
void AddLineStripList (System::String^ sName, array< Rx::Net::LineStrip3D^ >^aLineStripList, LineStripViewPars^ xPars, bool bClearScene)
 Adds a line strip list. More...
 
void AddLineStripList (System::String^ sName, array< Rx::Net::LineStrip3D^ >^aLineStripList, array< array< Rx::Net::Vector4D >^>^aLineStripColorList, LineStripViewPars^ xPars, bool bClearScene)
 Adds a line strip list. More...
 
void AddLineStripList (System::String^ sName, array< Rx::Net::LineStrip3D^ >^aLineStripList, array< array< double >^ >^aLineStripVelocityList, array< array< Rx::Net::Vector4D >^>^aLineStripColorList, LineStripViewPars^ xPars, bool bClearScene)
 Adds a line strip list. More...
 
void AddLineStripList (System::String^ sName, array< Rx::Net::LineStrip3D^ >^aLineStripList, array< System::Boolean >^aMask, LineStripViewPars^ xPars, bool bClearScene)
 Adds a line strip list. More...
 
void AddPointList (System::String^ sName, array< Rx::Net::Vector3D >^aPointList, Rx::Net::Vector4D vColor, PointViewPars^ xPars, bool bClearScene)
 Adds a point list. More...
 
void AddPointList (System::String^ sName, array< Rx::Net::ColorPoint3D >^aPointList, PointViewPars^ xPars, bool bClearScene)
 Adds a point list. More...
 
void AddPointList (System::String^ sName, array< Rx::Net::ColorPoint3D >^aColPntList, array< System::Boolean >^aMask, PointViewPars^ xPars, bool bClearScene)
 Adds a point list. 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 Clear ()
 Clears this object to its blank/initial state. More...
 
void Detach ()
 Detaches this ViewToolBase from the last view control. This resets the loaded script and makes this class invalid. More...
 
void EnableLineStripAnimation (System::String^ sName, bool bEnable, bool bPointsOnly, bool bEnablePicking)
 Enables or disables the line strip animation. More...
 
void SaveObjectList (System::String^ sFileName)
 Saves the object list to disk. More...
 
void SelectObject (System::String^ sName, int iPartId)
 Selects an object visually. More...
 

Protected Member Functions

virtual ~View3dTool ()
 Destructor. More...
 
void _Init ()
 Initializes this object. More...
 
virtual void _LoadToolScript () override
 Loads the internal tool script. 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...
 
System::Double UnitsPerMM [get, set]
 Gets or sets a factor that is applied to each vertex. Default is 1. More...
 
ViewCtrl^  ViewControl [get]
 Gets the view control that has this ViewToolBase attached. More...
 

Constructor & Destructor Documentation

CLUViz::Net::View3dTool::View3dTool ( )

Default constructor.

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

CLUViz::Net::View3dTool::View3dTool ( ViewCtrl xViewCtrl)

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

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

Destructor.

Member Function Documentation

void CLUViz::Net::View3dTool::_Init ( )
protected

Initializes this object.

virtual void CLUViz::Net::View3dTool::_LoadToolScript ( )
overrideprotectedvirtual

Loads the internal tool script.

Implements CLUViz::Net::ViewToolBase.

void CLUViz::Net::View3dTool::AddLineStripList ( System::String^  sName,
array< Rx::Net::LineStrip3D^ >^  aLineStripList,
LineStripViewPars xPars,
bool  bClearScene 
)

Adds a line strip list.

Parameters
sName[in] The object name.
aLineStripList[in] The list of line strips.
xPars[in] The drawing parameters.
bClearSceneTrue to clear the scene before adding this object.
void CLUViz::Net::View3dTool::AddLineStripList ( System::String^  sName,
array< Rx::Net::LineStrip3D^ >^  aLineStripList,
array< array< Rx::Net::Vector4D >^>^  aLineStripColorList,
LineStripViewPars xPars,
bool  bClearScene 
)

Adds a line strip list.

Parameters
sName[in] The object name.
aLineStripList[in] The list of line strips.
aLineStripColorList[in] The list of colors per line per line strip.
xPars[in] The drawing parameters.
bClearSceneTrue to clear the scene before adding this object.
void CLUViz::Net::View3dTool::AddLineStripList ( System::String^  sName,
array< Rx::Net::LineStrip3D^ >^  aLineStripList,
array< array< double >^ >^  aLineStripVelocityList,
array< array< Rx::Net::Vector4D >^>^  aLineStripColorList,
LineStripViewPars xPars,
bool  bClearScene 
)

Adds a line strip list.

Parameters
sName[in] The object name.
aLineStripList[in] The list of line strips.
aLineStripVelocityList[in] The list of velocities per line per line strip.
aLineStripColorList[in] The list of colors per line per line strip.
xPars[in] The drawing parameters.
bClearSceneTrue to clear the scene before adding this object.
void CLUViz::Net::View3dTool::AddLineStripList ( System::String^  sName,
array< Rx::Net::LineStrip3D^ >^  aLineStripList,
array< System::Boolean >^  aMask,
LineStripViewPars xPars,
bool  bClearScene 
)

Adds a line strip list.

Parameters
sName[in] The object name.
aLineStripList[in] The list of line strips.
aMask[in] The list of visible flags for each line strip.
xPars[in] The drawing parameters.
bClearSceneTrue to clear the scene before adding this object.
void CLUViz::Net::View3dTool::AddPointList ( System::String^  sName,
array< Rx::Net::Vector3D >^  aPointList,
Rx::Net::Vector4D  vColor,
PointViewPars xPars,
bool  bClearScene 
)

Adds a point list.

Parameters
sName[in] The object name.
aPointList[in] The list of points.
vColorThe color of all points.
xPars[in] The drawing parameters.
bClearSceneTrue to clear the scene before adding this object.
void CLUViz::Net::View3dTool::AddPointList ( System::String^  sName,
array< Rx::Net::ColorPoint3D >^  aPointList,
PointViewPars xPars,
bool  bClearScene 
)

Adds a point list.

Parameters
sName[in] The object name.
aPointList[in] The list of points.
xPars[in] The drawing parameters.
bClearSceneTrue to clear the scene before adding this object.
void CLUViz::Net::View3dTool::AddPointList ( System::String^  sName,
array< Rx::Net::ColorPoint3D >^  aColPntList,
array< System::Boolean >^  aMask,
PointViewPars xPars,
bool  bClearScene 
)

Adds a point list.

Parameters
sName[in] The object name.
aColPntList[in] The list of points.
aMask[in] The list of visible flags for each point.
xPars[in] The drawing parameters.
bClearSceneTrue to clear the scene before adding this object.
void CLUViz::Net::ViewToolBase::AttachTo ( ViewCtrl xViewCtrl)
inherited

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::View3dTool::Clear ( )

Clears this object to its blank/initial state.

void CLUViz::Net::ViewToolBase::Detach ( )
inherited

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

void CLUViz::Net::View3dTool::EnableLineStripAnimation ( System::String^  sName,
bool  bEnable,
bool  bPointsOnly,
bool  bEnablePicking 
)

Enables or disables the line strip animation.

Parameters
sName[in] The object name.
bEnableTrue to enable, false to disable.
bPointsOnlyTrue to enable animation only for points.
bEnablePickingTrue to enable, false to disable the picking.
void CLUViz::Net::View3dTool::SaveObjectList ( System::String^  sFileName)

Saves the object list to disk.

Parameters
sFileName[in] The file name.
void CLUViz::Net::View3dTool::SelectObject ( System::String^  sName,
int  iPartId 
)

Selects an object visually.

Parameters
sName[in] The object name.
iPartIdThe index of the object in its list.

Member Data Documentation

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

The standard VBO moniker

ViewCtrl ^ CLUViz::Net::ViewToolBase::m_xViewCtrl
protectedinherited

The view control

Property Documentation

int CLUViz::Net::ViewToolBase::CircleEdgeCount
inherited

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
getinherited

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.

System:: Double CLUViz::Net::View3dTool::UnitsPerMM
getset

Gets or sets a factor that is applied to each vertex. Default is 1.

ViewCtrl^ CLUViz::Net::ViewToolBase::ViewControl
getinherited

Gets the view control that has this ViewToolBase attached.