IS3D Namespace Reference

Classes
class	AnimMgr
class	AnimObj
class	BBox
class	CalibrateTracker
class	PingMessage
	Not used for normal ClusterSync operation, just for testing. More...
class	SyncMessage
class	ClusterEventMsg
class	ClusterEventBufferMsg
	A message that contains a buffer of many events. More...
class	ClusterSyncClient
class	ConfigMap
class	Color3Map
class	Color3Val
class	Cursor3D
class	DebugDraw
class	Default3DMenu
class	DefaultBtnHandler
class	DefaultHeadTrack
class	DefaultMouseNav
class	DeviceMgr
class	DrawMgr
class	DrawObj
class	Event
class	EventCallbackFunctor
class	EventCallbackSpecificFunctor
class	Event1DToEvent
class	EventDisplay
class	EventFilter
class	EyeProjectionObj
class	Fsa
class	FsaArc
class	FsaState
	FsaState class is only for use internally within the Fsa class. More...
class	FsaMgr
class	ICubeXDevice
class	IFSObj
class	InspectMouseNav
class	IS3DDraw
class	IS3DEngine
class	ISApp
class	KbdToTracker
class	MidiInDevice
class	MidiOutDevice
class	ModalVRFsa
class	ModelObj
class	MouseToTracker
class	MultiColumnMenu
class	PhantomDevice
class	PolledDevice
class	ProgressCallbackFunctor
class	ProgressCallbackSpecificFunctor
class	ProgressBar
class	SelectMgr
class	ShMemEventRelay
class	BoxObj
class	ArrowObj
class	AxesObj
class	SphereObj
class	TextObj
class	ScreenTextObj
class	NamedAxesObj
class	SoundImpNetwork
class	SoundServerNetMessagePlay
class	SoundImpOpenAL
class	SoundImpSDL
class	SoundImplementation
	base class for sound device implementations More...
class	SoundMgr
class	TexMgr
class	TextScreen
class	TrackedButton
class	VRPNAnalogDevice
class	VRPNButtonDevice
class	VRPNTrackerDevice
class	VRML2Parser
class	VRMLModel
class	VRMLObj
class	VRMLNode
class	VRMLPerspCameraNode
class	VRMLSeparatorNode
class	VRMLMaterialNode
class	VRMLCoordinatesNode
class	VRMLNormalsNode
class	VRMLIndexedFaceNode
class	VRMLGroupNode
class	VRMLSwitchNode
class	VRMLParser
class	NektarModel
class	NektarModelObj
class	TimerMgr
class	DefaultWandFlyNav
class	TextMessageFilter
class	ClusterCreator
class	ClusterBarrier
class	SpinLockBarrier
class	SemaphoreBarrier
class	SpinLockBarrierRenderingSide
class	SemaphoreBarrierRenderingSide
class	ClusterEventBuffer
class	ClusterEventBufferRenderingSide
Typedefs
typedef ReferenceCountedPointer< class CalibrateTracker >	CalibrateTrackerRef
typedef ReferenceCountedPointer< class Color3Val >	Color3ValRef
typedef ReferenceCountedPointer< class Color3Map >	Color3MapRef
typedef ReferenceCountedPointer< class DebugDraw >	DebugDrawRef
typedef ReferenceCountedPointer< class Default3DMenu >	Default3DMenuRef
typedef ReferenceCountedPointer< class DrawObj >	DrawObjRef
typedef ReferenceCountedPointer< class Event >	EventRef
typedef ReferenceCountedPointer< class EventDisplay >	EventDisplayRef
typedef ReferenceCountedPointer< class EventFilter >	EventFilterRef
typedef ReferenceCountedPointer< class EyeProjectionObj >	EyeProjectionObjRef
typedef ReferenceCountedPointer< class Fsa >	FsaRef
typedef ReferenceCountedPointer< class FsaArc >	FsaArcRef
	FsaArc class is only for use internally within the Fsa class.
typedef ReferenceCountedPointer< class IFSObj >	IFSObjRef
typedef ReferenceCountedPointer< class ClockSyncListener >	ClockSyncListenerRef
typedef ReferenceCountedPointer< class ModalVRFsa >	ModalVRFsaRef
typedef ReferenceCountedPointer< class ModelObj >	ModelObjRef
typedef ReferenceCountedPointer< class MultiColumnMenu >	MultiColumnMenuRef
typedef ReferenceCountedPointer< class ProgressBar >	ProgressBarRef
typedef ReferenceCountedPointer< class BoxObj >	BoxObjRef
typedef ReferenceCountedPointer< class ArrowObj >	ArrowObjRef
typedef ReferenceCountedPointer< class AxesObj >	AxesObjRef
typedef ReferenceCountedPointer< class SphereObj >	SphereObjRef
typedef ReferenceCountedPointer< class TextObj >	TextObjRef
typedef ReferenceCountedPointer< class ScreenTextObj >	ScreenTextObjRef
typedef ReferenceCountedPointer< class NamedAxesObj >	NamedAxesObjRef
typedef ReferenceCountedPointer< class SoundImpNetwork >	SoundImpNetworkRef
typedef ReferenceCountedPointer< class SoundImpSDL >	SoundImpSDLRef
typedef ReferenceCountedPointer< class SoundImplementation >	SoundImplementationRef
typedef ReferenceCountedPointer< class TextScreen >	TextScreenRef
typedef ReferenceCountedPointer< class VRML2Parser >	VRML2ParserRef
typedef ReferenceCountedPointer< class VRMLModel >	VRMLModelRef
typedef ReferenceCountedPointer< class VRMLObj >	VRMLObjRef
typedef ReferenceCountedPointer< class VRMLNode >	VRMLNodeRef
typedef ReferenceCountedPointer< class VRMLSeparatorNode >	VRMLSeparatorNodeRef
typedef ReferenceCountedPointer< class VRMLMaterialNode >	VRMLMaterialNodeRef
typedef ReferenceCountedPointer< class VRMLCoordinatesNode >	VRMLCoordinatesNodeRef
typedef ReferenceCountedPointer< class VRMLNormalsNode >	VRMLNormalsNodeRef
typedef ReferenceCountedPointer< class VRMLIndexedFaceNode >	VRMLIndexedFaceNodeRef
typedef ReferenceCountedPointer< class VRMLGroupNode >	VRMLGroupNodeRef
typedef ReferenceCountedPointer< class VRMLSwitchNode >	VRMLSwitchNodeRef
typedef ReferenceCountedPointer< class VRMLPerspCameraNode >	VRMLPerspCameraNodeRef
typedef ReferenceCountedPointer< class VRMLParser >	VRMLParserRef
typedef ReferenceCountedPointer< class NektarModel >	NektarModelRef
typedef ReferenceCountedPointer< class NektarModelObj >	NektarModelObjRef
typedef ReferenceCountedPointer< class TextMessageFilter >	TextMessageFilterRef
Enumerations
enum	ClusterMsgType {   NO_MSG = 0, Ping_MSG = 2001, Sync_MSG = 2002, Event_MSG = 2003,   EventBuffer_MSG = 2004 }
enum	SOUNDPARAM {   SP_LOOP = 0, SP_PITCH = 1, SP_GAIN = 2, SP_POSX = 3,   SP_POSY = 4, SP_POSZ = 5, SP_VELX = 6, SP_VELY = 7,   SP_VELZ = 8, SP_NUM_PARAMS = 9 }
Functions
template<class KEYTYPE, class VALTYPE>
VALTYPE	ConfigVal (KEYTYPE keyString, const VALTYPE &defaultVal, bool warn=true)
std::string	ConfigVal (QUOTED_STRING keyString, QUOTED_STRING defaultVal, bool warn=true)
std::string	ConfigVal (QUOTED_STRING keyString, std::string defaultVal, bool warn=true)
std::string	ConfigVal (std::string keyString, QUOTED_STRING defaultVal, bool warn=true)
std::string	ConfigVal (std::string keyString, std::string defaultVal, bool warn=true)
std::string	decygifyPath (const std::string &in)
std::string	replaceEnvVars (const std::string &in)
EventRef	createCopyOfEvent (EventRef e)
std::ostream &	operator<< (std::ostream &os, const Vector2 &vec2)
std::istream &	operator>> (std::istream &is, Vector2 &vec2)
std::istream &	operator>> (std::istream &is, Vector3 &vec3)
std::ostream &	operator<< (std::ostream &os, const Matrix3 &m)
std::istream &	operator>> (std::istream &is, Matrix3 &m)
std::ostream &	operator<< (std::ostream &os, const Matrix4 &m)
std::istream &	operator>> (std::istream &is, Matrix4 &m)
std::istream &	operator>> (std::istream &is, CoordinateFrame &m)
std::ostream &	operator<< (std::ostream &os, const Color3 &c)
std::istream &	operator>> (std::istream &is, Color3 &c)
std::ostream &	operator<< (std::ostream &os, const Color4 &c)
std::istream &	operator>> (std::istream &is, Color4 &c)
std::string	matrix4ToString (Matrix4 m)
std::string	coordinateFrameToString (CoordinateFrame cf)
Vector3	rgbToHls (Color3 rgbColor)
Color3	hlsToRgb (Vector3 hlsColor)
double	colorDistance (const Color3 &rgb1, const Color3 &rgb2)

---

Typedef Documentation

typedef ReferenceCountedPointer<class ArrowObj> IS3D::ArrowObjRef

typedef ReferenceCountedPointer<class AxesObj> IS3D::AxesObjRef

typedef ReferenceCountedPointer<class BoxObj> IS3D::BoxObjRef

typedef ReferenceCountedPointer<class CalibrateTracker> IS3D::CalibrateTrackerRef

typedef ReferenceCountedPointer<class ClockSyncListener> IS3D::ClockSyncListenerRef

typedef ReferenceCountedPointer<class Color3Map> IS3D::Color3MapRef

typedef ReferenceCountedPointer<class Color3Val> IS3D::Color3ValRef

typedef ReferenceCountedPointer<class DebugDraw> IS3D::DebugDrawRef

typedef ReferenceCountedPointer<class Default3DMenu> IS3D::Default3DMenuRef

typedef ReferenceCountedPointer<class DrawObj> IS3D::DrawObjRef

typedef ReferenceCountedPointer<class EventDisplay> IS3D::EventDisplayRef

typedef ReferenceCountedPointer<class EventFilter> IS3D::EventFilterRef

typedef ReferenceCountedPointer<class Event> IS3D::EventRef

typedef ReferenceCountedPointer<class EyeProjectionObj> IS3D::EyeProjectionObjRef

typedef ReferenceCountedPointer<class FsaArc> IS3D::FsaArcRef

FsaArc class is only for use internally within the Fsa class.

typedef ReferenceCountedPointer<class Fsa> IS3D::FsaRef

typedef ReferenceCountedPointer<class IFSObj> IS3D::IFSObjRef

typedef ReferenceCountedPointer<class ModalVRFsa> IS3D::ModalVRFsaRef

typedef ReferenceCountedPointer<class ModelObj> IS3D::ModelObjRef

typedef ReferenceCountedPointer<class MultiColumnMenu> IS3D::MultiColumnMenuRef

typedef ReferenceCountedPointer<class NamedAxesObj> IS3D::NamedAxesObjRef

typedef ReferenceCountedPointer<class NektarModelObj> IS3D::NektarModelObjRef

typedef ReferenceCountedPointer<class NektarModel> IS3D::NektarModelRef

typedef ReferenceCountedPointer<class ProgressBar> IS3D::ProgressBarRef

typedef ReferenceCountedPointer<class ScreenTextObj> IS3D::ScreenTextObjRef

typedef ReferenceCountedPointer<class SoundImplementation> IS3D::SoundImplementationRef

typedef ReferenceCountedPointer<class SoundImpNetwork> IS3D::SoundImpNetworkRef

typedef ReferenceCountedPointer<class SoundImpSDL> IS3D::SoundImpSDLRef

typedef ReferenceCountedPointer<class SphereObj> IS3D::SphereObjRef

typedef ReferenceCountedPointer<class TextMessageFilter> IS3D::TextMessageFilterRef

typedef ReferenceCountedPointer<class TextObj> IS3D::TextObjRef

typedef ReferenceCountedPointer<class TextScreen> IS3D::TextScreenRef

typedef ReferenceCountedPointer<class VRML2Parser> IS3D::VRML2ParserRef

typedef ReferenceCountedPointer< class VRMLCoordinatesNode > IS3D::VRMLCoordinatesNodeRef

typedef ReferenceCountedPointer< class VRMLGroupNode > IS3D::VRMLGroupNodeRef

typedef ReferenceCountedPointer< class VRMLIndexedFaceNode > IS3D::VRMLIndexedFaceNodeRef

typedef ReferenceCountedPointer< class VRMLMaterialNode > IS3D::VRMLMaterialNodeRef

typedef ReferenceCountedPointer<class VRMLModel> IS3D::VRMLModelRef

typedef ReferenceCountedPointer< class VRMLNode > IS3D::VRMLNodeRef

typedef ReferenceCountedPointer< class VRMLNormalsNode > IS3D::VRMLNormalsNodeRef

typedef ReferenceCountedPointer<class VRMLObj> IS3D::VRMLObjRef

typedef ReferenceCountedPointer<class VRMLParser> IS3D::VRMLParserRef

typedef ReferenceCountedPointer< class VRMLPerspCameraNode > IS3D::VRMLPerspCameraNodeRef

typedef ReferenceCountedPointer< class VRMLSeparatorNode > IS3D::VRMLSeparatorNodeRef

typedef ReferenceCountedPointer< class VRMLSwitchNode > IS3D::VRMLSwitchNodeRef

---

Enumeration Type Documentation

enum IS3D::ClusterMsgType

Enumerator:

NO_MSG
Ping_MSG
Sync_MSG
Event_MSG
EventBuffer_MSG

enum IS3D::SOUNDPARAM

Enumerator:

SP_LOOP
SP_PITCH
SP_GAIN
SP_POSX
SP_POSY
SP_POSZ
SP_VELX
SP_VELY
SP_VELZ
SP_NUM_PARAMS

---

Function Documentation

double IS3D::colorDistance	(	const Color3 &	rgb1,
		const Color3 &	rgb2
	)

std::string IS3D::ConfigVal	(	std::string	keyString,
		std::string	defaultVal,
		bool	warn = true
	)			[inline]

References IS3D::ConfigMap::containsKey(), IS3D::ConfigMap::getValue(), and replaceEnvVars().

std::string IS3D::ConfigVal	(	std::string	keyString,
		QUOTED_STRING	defaultVal,
		bool	warn = true
	)			[inline]

References IS3D::ConfigMap::containsKey(), IS3D::ConfigMap::getValue(), and replaceEnvVars().

std::string IS3D::ConfigVal	(	QUOTED_STRING	keyString,
		std::string	defaultVal,
		bool	warn = true
	)			[inline]

References IS3D::ConfigMap::containsKey(), IS3D::ConfigMap::getValue(), and replaceEnvVars().

std::string IS3D::ConfigVal	(	QUOTED_STRING	keyString,
		QUOTED_STRING	defaultVal,
		bool	warn = true
	)			[inline]

References IS3D::ConfigMap::containsKey(), IS3D::ConfigMap::getValue(), and replaceEnvVars().

template<class KEYTYPE, class VALTYPE>

VALTYPE IS3D::ConfigVal	(	KEYTYPE	keyString,
		const VALTYPE &	defaultVal,
		bool	warn = true
	)			[inline]

This is the main templated function that is used to access a ConfigVal. The value is stored internally as a string, the function will attempt to reinterpret the value as the same type as that which is passed in to the defaultVal parameter. This function is overridden by several variants below for various string-like types, which generally don't require a type conversion, but can confuse a compiler.

References IS3D::ConfigMap::containsKey(), and IS3D::ConfigMap::getValue().

std::string IS3D::coordinateFrameToString

(

CoordinateFrame

cf

)

EventRef IS3D::createCopyOfEvent

(

EventRef

e

)

Creates a copy of the Event pointed to by e and returns a ref counted pointer to the new copy.

std::string IS3D::decygifyPath

(

const std::string &

in

)

This function changes occurances of /cygdrive/c/folder1/folder2/etc.. to c:/folder1/folder2/etc.. when running in Windows. Paths coming from program arguments or environment variables will tend to take the /cygdrive/<drive-letter>/ form when running under cygwin, but file commands compiled with the MS Visual C++ compiler can't deal with paths of this form.

Color3 IS3D::hlsToRgb

(

Vector3

hlsColor

)

std::string IS3D::matrix4ToString

(

Matrix4

m

)

std::ostream& IS3D::operator<<	(	std::ostream &	os,
		const Color4 &	c
	)

std::ostream& IS3D::operator<<	(	std::ostream &	os,
		const Color3 &	c
	)

std::ostream& IS3D::operator<<	(	std::ostream &	os,
		const Matrix4 &	m
	)

std::ostream& IS3D::operator<<	(	std::ostream &	os,
		const Matrix3 &	m
	)

std::ostream& IS3D::operator<<	(	std::ostream &	os,
		const Vector2 &	vec2
	)

std::istream& IS3D::operator>>	(	std::istream &	is,
		Color4 &	c
	)

std::istream& IS3D::operator>>	(	std::istream &	is,
		Color3 &	c
	)

std::istream& IS3D::operator>>	(	std::istream &	is,
		CoordinateFrame &	m
	)

std::istream& IS3D::operator>>	(	std::istream &	is,
		Matrix4 &	m
	)

std::istream& IS3D::operator>>	(	std::istream &	is,
		Matrix3 &	m
	)

std::istream& IS3D::operator>>	(	std::istream &	is,
		Vector3 &	vec3
	)

std::istream& IS3D::operator>>	(	std::istream &	is,
		Vector2 &	vec2
	)

std::string IS3D::replaceEnvVars

(

const std::string &

in

)

Given an input string, replaces all occurances of with the decygified (see above) value of the environment variable NAME. If NAME is not defined, then a blank string is returned.

Referenced by ConfigVal().

Vector3 IS3D::rgbToHls

(

Color3

rgbColor

)