OctreeSceneStats Class Reference

Collects statistics for calculating and sending a scene from a octree server to an interface client. More...

#include <OctreeSceneStats.h>

Classes
struct	ItemInfo
	Meta information about each stats item. More...

Public Types
enum	Item
	List of various items tracked by OctreeSceneStats which can be accessed via getItemInfo() and getItemValue()

Public Member Functions
void	sceneStarted (bool fullScene, bool moving, const OctreeElementPointer &root)
	Call when beginning the computation of a scene. Initializes internal structures.
void	sceneCompleted ()
	Call when the computation of a scene is completed. Finalizes internal structures.
void	packetSent (int bytes)
	Track that a packet was sent as part of the scene.
void	encodeStarted ()
	Tracks the beginning of an encode pass during scene calculation.
void	encodeStopped ()
	Tracks the ending of an encode pass during scene calculation.
void	traversed (const OctreeElementPointer &element)
	Track that a element was traversed as part of computation of a scene.
void	skippedDistance (const OctreeElementPointer &element)
	Track that a element was skipped as part of computation of a scene due to being beyond the LOD distance.
void	skippedOutOfView (const OctreeElementPointer &element)
	Track that a element was skipped as part of computation of a scene due to being out of view.
void	skippedWasInView (const OctreeElementPointer &element)
	Track that a element was skipped as part of computation of a scene due to previously being in view while in delta sending.
void	skippedNoChange (const OctreeElementPointer &element)
	Track that a element was skipped as part of computation of a scene due to not having changed since last full scene sent.
void	skippedOccluded (const OctreeElementPointer &element)
	Track that a element was skipped as part of computation of a scene due to being occluded.
void	colorSent (const OctreeElementPointer &element)
	Track that a element's color was was sent as part of computation of a scene.
void	didntFit (const OctreeElementPointer &element)
	Track that a element was due to be sent, but didn't fit in the packet and was moved to next packet.
void	existsBitsWritten ()
	Track that the exists in tree bitmask was was sent as part of computation of a scene.
void	existsInPacketBitsWritten ()
	Track that the exists in packet bitmask was was sent as part of computation of a scene.
void	childBitsRemoved (bool includesExistsBits)
	Fix up tracking statistics in case where bitmasks were removed for some reason.
int	packIntoPacket ()
	Pack the details of the statistics into a buffer for sending as a network packet.
int	unpackFromPacket (ReceivedMessage &packet)
	Unpack the details of the statistics from a network packet.
bool	isReadyToSend () const
	Indicates that a scene has been completed and the statistics are ready to be sent.
void	markAsSent ()
	Mark that the scene statistics have been sent.
ItemInfo &	getItemInfo (Item item)
const char *	getItemValue (Item item)

Detailed Description

Collects statistics for calculating and sending a scene from a octree server to an interface client.

Member Function Documentation

getItemInfo()

ItemInfo& OctreeSceneStats::getItemInfo ( Item  item )

inline

Returns details about items tracked by OctreeSceneStats

Parameters

Item	item The item from the stats you're interested in.

getItemValue()

const char * OctreeSceneStats::getItemValue

(

Item

item

)

Returns a UI formatted value of an item tracked by OctreeSceneStats

Parameters

Item	item The item from the stats you're interested in.

---

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

• OctreeSceneStats.h
• OctreeSceneStats.cpp