ASR::DynamicLines Class Reference

#include <DynamicLines.h>

Inheritance diagram for ASR::DynamicLines:

[legend]Collaboration diagram for ASR::DynamicLines:

[legend]List of all members.

Public Member Functions
	DynamicLines (OperationType opType=Ogre::RenderOperation::OT_LINE_STRIP)
	Constructor - see setOperationType() for description of argument.
virtual	~DynamicLines ()
void	addPoint (const Ogre::Vector3 &p)
	Add a point to the point list.
void	addPoint (Real x, Real y, Real z)
	Add a point to the point list.
void	setPoint (unsigned short index, const Vector3 &value)
	Change the location of an existing point in the point list.
const Vector3 &	getPoint (unsigned short index) const
	Return the location of an existing point in the point list.
unsigned short	getNumPoints (void) const
	Return the total number of points in the point list.
void	clear ()
	Remove all points from the point list.
void	update ()
	Call this to update the hardware buffer after making changes.
void	setOperationType (OperationType opType)
	Set the type of operation to draw with.
OperationType	getOperationType () const
Protected Member Functions
virtual void	createVertexDeclaration ()
	Implementation DynamicRenderable, creates a simple vertex-only decl.
virtual void	fillHardwareBuffers ()
	Implementation DynamicRenderable, pushes point list out to hardware memory.
Private Types
typedef Ogre::Vector3	Vector3
typedef Ogre::Quaternion	Quaternion
typedef Ogre::Camera	Camera
typedef Ogre::Real	Real
typedef Ogre::RenderOperation::OperationType	OperationType
Private Attributes
std::vector< Vector3 >	mPoints
bool	mDirty

---

Detailed Description

Definition at line 12 of file DynamicLines.h.

---

Member Typedef Documentation

typedef Ogre::Camera ASR::DynamicLines::Camera [private]

Definition at line 16 of file DynamicLines.h.

typedef Ogre::RenderOperation::OperationType ASR::DynamicLines::OperationType [private]

Definition at line 18 of file DynamicLines.h.

typedef Ogre::Quaternion ASR::DynamicLines::Quaternion [private]

Definition at line 15 of file DynamicLines.h.

typedef Ogre::Real ASR::DynamicLines::Real [private]

Definition at line 17 of file DynamicLines.h.

typedef Ogre::Vector3 ASR::DynamicLines::Vector3 [private]

Definition at line 14 of file DynamicLines.h.

---

Constructor & Destructor Documentation

ASR::DynamicLines::DynamicLines

(

OperationType

opType = Ogre::RenderOperation::OT_LINE_STRIP

)

Constructor - see setOperationType() for description of argument.

Definition at line 16 of file DynamicLines.cpp.

References ASR::DynamicRenderable::initialize(), and mDirty.

        {
                initialize(opType,false);
                setMaterial("BaseWhiteNoLighting");
                mDirty = true;
        }

ASR::DynamicLines::~DynamicLines

(

)

[virtual]

Definition at line 23 of file DynamicLines.cpp.

        {
        }

---

Member Function Documentation

void ASR::DynamicLines::addPoint	(	Real	x,
		Real	y,
		Real	z
	)

Add a point to the point list.

Definition at line 42 of file DynamicLines.cpp.

References mDirty, and mPoints.

        {
                mPoints.push_back(Vector3(x,y,z));
                mDirty = true;
        }

void ASR::DynamicLines::addPoint

(

const Ogre::Vector3 &

p

)

Add a point to the point list.

void ASR::DynamicLines::clear

(

)

Remove all points from the point list.

Definition at line 63 of file DynamicLines.cpp.

References mDirty, and mPoints.

        {
                mPoints.clear();
                mDirty = true;
        }

void ASR::DynamicLines::createVertexDeclaration

(

)

[protected, virtual]

Implementation DynamicRenderable, creates a simple vertex-only decl.

Implements ASR::DynamicRenderable.

Definition at line 74 of file DynamicLines.cpp.

References ASR::POSITION_BINDING.

        {
                VertexDeclaration *decl = mRenderOp.vertexData->vertexDeclaration;
                decl->addElement(POSITION_BINDING, 0, VET_FLOAT3, VES_POSITION);
        }

void ASR::DynamicLines::fillHardwareBuffers

(

)

[protected, virtual]

Implementation DynamicRenderable, pushes point list out to hardware memory.

Implements ASR::DynamicRenderable.

Definition at line 80 of file DynamicLines.cpp.

References mDirty, mPoints, and ASR::DynamicRenderable::prepareHardwareBuffers().

Referenced by update().

        {
                int size = mPoints.size();

                prepareHardwareBuffers(size,0);

                if (!size) { 
                        mBox.setExtents(Vector3::ZERO,Vector3::ZERO);
                        mDirty=false;
                        return;
                }

                Vector3 vaabMin = mPoints[0];
                Vector3 vaabMax = mPoints[0];

                HardwareVertexBufferSharedPtr vbuf =
                        mRenderOp.vertexData->vertexBufferBinding->getBuffer(0);

                Real *prPos = static_cast<Real*>(vbuf->lock(HardwareBuffer::HBL_DISCARD));
                {
                        for(int i = 0; i < size; i++)
                        {
                                *prPos++ = mPoints[i].x;
                                *prPos++ = mPoints[i].y;
                                *prPos++ = mPoints[i].z;

                                if(mPoints[i].x < vaabMin.x)
                                        vaabMin.x = mPoints[i].x;
                                if(mPoints[i].y < vaabMin.y)
                                        vaabMin.y = mPoints[i].y;
                                if(mPoints[i].z < vaabMin.z)
                                        vaabMin.z = mPoints[i].z;

                                if(mPoints[i].x > vaabMax.x)
                                        vaabMax.x = mPoints[i].x;
                                if(mPoints[i].y > vaabMax.y)
                                        vaabMax.y = mPoints[i].y;
                                if(mPoints[i].z > vaabMax.z)
                                        vaabMax.z = mPoints[i].z;
                        }
                }
                vbuf->unlock();

                mBox.setExtents(vaabMin, vaabMax);

                mDirty = false;
        }

unsigned short ASR::DynamicLines::getNumPoints

(

void

)

const

Return the total number of points in the point list.

Definition at line 52 of file DynamicLines.cpp.

References mPoints.

        {
                return (unsigned short)mPoints.size();
        }

RenderOperation::OperationType ASR::DynamicLines::getOperationType

(

)

const

Definition at line 32 of file DynamicLines.cpp.

        {
                return mRenderOp.operationType;
        }

const Vector3 & ASR::DynamicLines::getPoint

(

unsigned short

index

)

const

Return the location of an existing point in the point list.

Definition at line 47 of file DynamicLines.cpp.

References mPoints.

        {
                assert(index < mPoints.size() && "Point index is out of bounds!!");
                return mPoints[index];
        }

void ASR::DynamicLines::setOperationType

(

OperationType

opType

)

Set the type of operation to draw with.

Parameters:

opType

Can be one of RenderOperation::OT_LINE_STRIP RenderOperation::OT_LINE_LIST RenderOperation::OT_POINT_LIST RenderOperation::OT_TRIANGLE_LIST RenderOperation::OT_TRIANGLE_STRIP RenderOperation::OT_TRIANGLE_FAN The default is OT_LINE_STRIP.

Definition at line 27 of file DynamicLines.cpp.

        {
                mRenderOp.operationType = opType;
        }

void ASR::DynamicLines::setPoint	(	unsigned short	index,
		const Vector3 &	value
	)

Change the location of an existing point in the point list.

Definition at line 56 of file DynamicLines.cpp.

References mDirty, and mPoints.

        {
                assert(index < mPoints.size() && "Point index is out of bounds!!");

                mPoints[index] = value;
                mDirty = true;
        }

void ASR::DynamicLines::update

(

)

Call this to update the hardware buffer after making changes.

Definition at line 69 of file DynamicLines.cpp.

References fillHardwareBuffers(), and mDirty.

        {
                if (mDirty) fillHardwareBuffers();
        }

---

Member Data Documentation

bool ASR::DynamicLines::mDirty [private]

Definition at line 66 of file DynamicLines.h.

Referenced by addPoint(), clear(), DynamicLines(), fillHardwareBuffers(), setPoint(), and update().

std::vector<Vector3> ASR::DynamicLines::mPoints [private]

Definition at line 65 of file DynamicLines.h.

Referenced by addPoint(), clear(), fillHardwareBuffers(), getNumPoints(), getPoint(), and setPoint().

---

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

• D:/simple_rts/include/DynamicLines.h
• D:/simple_rts/src/DynamicLines.cpp

---