SO3Engine
Public Member Functions | List of all members
SO3::SLines Class Reference

#include <SO3Lines.h>

Inheritance diagram for SO3::SLines:

Public Member Functions

 SLines (const Ogre::ColourValue &defaultColour=Ogre::ColourValue::White, bool dashed=false, bool disableDepth=false)
 
 ~SLines ()
 
Ogre::ColourValue GetColour ()
 
void SetColour (const Ogre::ColourValue &newColour)
 
void AddLine (const Ogre::Vector3 &start, const Ogre::Vector3 &end)
 
void AddLine (const Ogre::Real &start_x, const Ogre::Real &start_y, const Ogre::Real &start_z, const Ogre::Real &end_x, const Ogre::Real &end_y, const Ogre::Real &end_z)
 
void AddPoint (const size_t &pointIndex, const Ogre::Vector3 &pt)
 
void AddPoint (const size_t &pointIndex, const Ogre::Real &x, const Ogre::Real &y, const Ogre::Real &z)
 
void AddPoint (const Ogre::Vector3 &pt)
 
void RemovePoint (const size_t &pointIndex)
 
void AddPoint (const Ogre::Real &x, const Ogre::Real &y, const Ogre::Real &z)
 
size_t GetNumberOfPoints () const
 
Ogre::Vector3 GetPoint (const size_t &pointIndex)
 
void SetPoint (const size_t &pointIndex, const Ogre::Vector3 &pt)
 
void SetPoint (const size_t &pointIndex, const Ogre::Real &x, const Ogre::Real &y, const Ogre::Real &z)
 
void Draw ()
 
void DrawDash ()
 
void SetDashed (bool dashed)
 
bool GetDashed ()
 
void Clear ()
 
virtual Ogre::Real getSquaredViewDepth (const Ogre::Camera *cam) const
 
virtual Ogre::Real getBoundingRadius () const
 

Detailed Description

Definition at line 13 of file SO3Lines.h.

Constructor & Destructor Documentation

◆ SLines()

SO3::SLines::SLines ( const Ogre::ColourValue &  defaultColour = Ogre::ColourValue::White,
bool  dashed = false,
bool  disableDepth = false 
)

Definition at line 10 of file SO3Lines.cpp.

◆ ~SLines()

SO3::SLines::~SLines ( )

Definition at line 51 of file SO3Lines.cpp.

Member Function Documentation

◆ AddLine() [1/2]

void SO3::SLines::AddLine ( const Ogre::Real &  start_x,
const Ogre::Real &  start_y,
const Ogre::Real &  start_z,
const Ogre::Real &  end_x,
const Ogre::Real &  end_y,
const Ogre::Real &  end_z 
)

Definition at line 91 of file SO3Lines.cpp.

◆ AddLine() [2/2]

void SO3::SLines::AddLine ( const Ogre::Vector3 &  start,
const Ogre::Vector3 &  end 
)

Definition at line 83 of file SO3Lines.cpp.

◆ AddPoint() [1/4]

void SO3::SLines::AddPoint ( const Ogre::Real &  x,
const Ogre::Real &  y,
const Ogre::Real &  z 
)

Definition at line 121 of file SO3Lines.cpp.

◆ AddPoint() [2/4]

void SO3::SLines::AddPoint ( const Ogre::Vector3 &  pt)

Definition at line 115 of file SO3Lines.cpp.

◆ AddPoint() [3/4]

void SO3::SLines::AddPoint ( const size_t &  pointIndex,
const Ogre::Real &  x,
const Ogre::Real &  y,
const Ogre::Real &  z 
)

Definition at line 110 of file SO3Lines.cpp.

◆ AddPoint() [4/4]

void SO3::SLines::AddPoint ( const size_t &  pointIndex,
const Ogre::Vector3 &  pt 
)

Definition at line 96 of file SO3Lines.cpp.

◆ Clear()

void SO3::SLines::Clear ( )

Remove all the points.

Definition at line 57 of file SO3Lines.cpp.

◆ Draw()

void SO3::SLines::Draw ( )

Render the line.

Definition at line 181 of file SO3Lines.cpp.

◆ DrawDash()

void SO3::SLines::DrawDash ( )

Render the dash line.

Definition at line 262 of file SO3Lines.cpp.

◆ getBoundingRadius()

Ogre::Real SO3::SLines::getBoundingRadius ( ) const
virtual

Definition at line 318 of file SO3Lines.cpp.

◆ GetColour()

Ogre::ColourValue SO3::SLines::GetColour ( )

Retrieve the actual color of the line.

Definition at line 72 of file SO3Lines.cpp.

◆ GetDashed()

bool SO3::SLines::GetDashed ( )

Definition at line 176 of file SO3Lines.cpp.

◆ GetNumberOfPoints()

size_t SO3::SLines::GetNumberOfPoints ( ) const

Definition at line 137 of file SO3Lines.cpp.

◆ GetPoint()

Ogre::Vector3 SO3::SLines::GetPoint ( const size_t &  pointIndex)

Definition at line 142 of file SO3Lines.cpp.

◆ getSquaredViewDepth()

Ogre::Real SO3::SLines::getSquaredViewDepth ( const Ogre::Camera *  cam) const
virtual

Definition at line 307 of file SO3Lines.cpp.

◆ RemovePoint()

void SO3::SLines::RemovePoint ( const size_t &  pointIndex)

Definition at line 126 of file SO3Lines.cpp.

◆ SetColour()

void SO3::SLines::SetColour ( const Ogre::ColourValue &  newColour)

Set the colour of the line.

Definition at line 77 of file SO3Lines.cpp.

◆ SetDashed()

void SO3::SLines::SetDashed ( bool  dashed)

Definition at line 171 of file SO3Lines.cpp.

◆ SetPoint() [1/2]

void SO3::SLines::SetPoint ( const size_t &  pointIndex,
const Ogre::Real &  x,
const Ogre::Real &  y,
const Ogre::Real &  z 
)

Definition at line 166 of file SO3Lines.cpp.

◆ SetPoint() [2/2]

void SO3::SLines::SetPoint ( const size_t &  pointIndex,
const Ogre::Vector3 &  pt 
)

Definition at line 155 of file SO3Lines.cpp.


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