TPProto::GetObjectByPos Class Reference

Frame for getting all objects within a given area. More...

#include <getobjectbypos.h>

Inheritance diagram for TPProto::GetObjectByPos:

List of all members.

Public Member Functions
	GetObjectByPos ()
	Default constructor.
virtual	~GetObjectByPos ()
	Required virtual destructor.
void	packBuffer (Buffer *buf)
	Pack the Frame into a Buffer.
bool	unpackBuffer (Buffer *buf)
	Unpack Buffer, always false.
void	setPosition (const Vector3d &npos)
	Sets the position for the centre of the area to be looked at.
void	setRadius (uint64_t nrad)
	Sets the radius for the area to be looked at.

---

Detailed Description

Frame for getting all objects within a given area.

The area is a sphere of radius units centre at the position.

---

Constructor & Destructor Documentation

TPProto::GetObjectByPos::GetObjectByPos

(

)

Default constructor.

Sets the position to 0,0,0 (centre of the universe) and the radius to 0.

---

Member Function Documentation

void TPProto::GetObjectByPos::packBuffer

(

Buffer *

buf

)

[virtual]

Pack the Frame into a Buffer.

Parameters:

buf

The Buffer to pack into.

Implements TPProto::Frame.

bool TPProto::GetObjectByPos::unpackBuffer

(

Buffer *

buf

)

[virtual]

Unpack Buffer, always false.

This Frame should never be received, therefore this method always returns false.

Returns:

False, always.

Implements TPProto::Frame.

void TPProto::GetObjectByPos::setPosition

(

const Vector3d &

npos

)

Sets the position for the centre of the area to be looked at.

Parameters:

npos

The position to be taken as the centre.

void TPProto::GetObjectByPos::setRadius

(

uint64_t

nrad

)

Sets the radius for the area to be looked at.

Parameters:

nrad

The radius to be used.

---

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

• tpproto/getobjectbypos.h
• tpproto/getobjectbypos.cpp

---