Sirikata::Graphics Namespace Reference

Namespace for the OGRE Graphics Plugin: see class OgreSystem. More...

Classes
class	Camera
class	EntityListener
class	Entity
	Base class for objects represented in Ogre as a mesh. More...
class	ParseMeshTaskInfo
class	OgreRenderer
	Represents a SQLite database connection. More...
class	ResourceDownloadPlanner
	Interface for service which plans when and what order to download meshes and their associated resources like textures and then passes them off to Ogre for loading. More...
class	CDNArchive
	A specialization of Ogre::Archive which gets its data through Meru's ResourceManager, and therefore indirectly via the web. More...
class	CDNArchiveFactory
	Archive factory for URLArchives, a specialization of Ogre::ArchiveFactory. More...
class	CDNArchivePlugin
	Plugin to setup CDNArchive and CDNArchive factory with Ogre. More...
class	ReplacingDataStream
	A class that replaces text out of an Ogre DataStream as it is read Currently does the simple thing by reading the entire document as a string whenever data is requested. More...
struct	Skybox
	A skybox (or skydome, skyplane, etc). More...
class	ViewportOverlay
class	WebView
	A 'WebView' is essentially an offscreen browser window rendered to a dynamic texture (encapsulated as an Ogre Material) that can optionally be contained within a viewport overlay. More...
struct	WebViewCoord
class	WebViewManager
	Supreme dictator and Singleton: WebViewManager. More...
class	ReplaceTexture
class	ShouldReplaceTexture
class	ManualMaterialLoader
class	ManualMeshLoader
class	ManualSkeletonLoader
class	PriorityDownloadPlannerMetric
	Interface for a metric that can be used with PriorityDownloadPlanner. More...
class	DistanceDownloadPlannerMetric
class	SolidAngleDownloadPlannerMetric
class	PriorityDownloadPlanner
	Implementation of ResourceDownloadPlanner that orders loading by a priority metric computed on each object. More...
class	ResourceLoader
	ResourceLoader manages the loading of resources into Ogre. More...
class	CDNArchiveDataStream
class	CubeMap
struct	TriVertex
struct	Triangle
struct	IntersectResult
class	OgreMesh
	This class syncs Ogre::Meshes from the hardware and does ray intersection tests. More...
struct	RayTraceResult
class	OgreSystem
	Represents one OGRE SceneManager, a single environment. More...
class	OgreSystemInputHandler
class	ProxyEntityListener
class	ProxyEntity
	Ogre entities using ProxyObjects for their information. More...
Typedefs
typedef std::tr1::shared_ptr < Entity >	EntityPtr
typedef std::tr1::shared_ptr < ParseMeshTaskInfo >	ParseMeshTaskHandle
typedef std::tr1::shared_ptr < Skybox >	SkyboxPtr
typedef std::tr1::weak_ptr < Skybox >	SkyboxWPtr
typedef std::map< String, String >	TextureBindingsMap
typedef std::tr1::shared_ptr < TextureBindingsMap >	TextureBindingsMapPtr
typedef std::tr1::function < boost::any(WebView *, const JSArguments &)	JSDelegate )
	Delegate for method calls from JS -> C++.
typedef std::tr1::shared_ptr < PriorityDownloadPlannerMetric >	PriorityDownloadPlannerMetricPtr
Enumerations
enum	Tier { TIER_BACK = 0, TIER_MIDDLE, TIER_FRONT }
	An enumeration of the three tiers ViewportOverlays can reside in. More...
enum	MouseButtonID {   LeftMouseButton = 0, RightMouseButton = 1, MiddleMouseButton = 2, ScrollUpButton = 3,   ScrollDownButton = 4, UnknownMouseButton = 0xFFFF }
	Enumerates internal mouse button IDs. More...
Functions
float	computeClosestPower (const Color &source, const Color &target, float32 power)
void	updateOgreLight (Ogre::Light *light, const LightInfo &linfo)
Ogre::Light *	constructOgreLight (Ogre::SceneManager *mgr, const String &name, const LightInfo &linfo)
Ogre::Quaternion	toOgre (const Sirikata::Quaternion &quat)
Ogre::Vector3	toOgre (const Sirikata::Vector3f &pos)
Ogre::Vector3	toOgre (const Sirikata::Vector3d &pos, const Sirikata::Vector3d &base)
Ogre::Vector4	toOgre (const Sirikata::Vector4f &pos)
Ogre::ColourValue	toOgreRGBA (const Sirikata::ColorAlpha &rgba)
Ogre::ColourValue	toOgreRGB (const Sirikata::Color &rgb)
Ogre::ColourValue	toOgreRGBA (const Sirikata::Color &rgb, float32 alpha)
Sirikata::Quaternion	fromOgre (const Ogre::Quaternion &quat)
Sirikata::Vector3f	fromOgre (const Ogre::Vector3 &pos)
Sirikata::Vector3d	fromOgre (const Ogre::Vector3 &pos, const Vector3d &base)
Sirikata::Vector4f	fromOgre (const Ogre::Vector4 &pos)
Sirikata::ColorAlpha	fromOgreRGBA (const Ogre::ColourValue &rgba)
Sirikata::Color	fromOgreRGB (const Ogre::ColourValue &rgba)
String	ogreVisualName (Mesh::VisualPtr vis, TextureBindingsMapPtr bindings)
String	ogreMaterialName (const Mesh::MaterialEffectInfo &mat, const Transfer::URI &parent_uri, TextureBindingsMapPtr bindings)
String	ogreBillboardMaterialName (TextureBindingsMapPtr bindings)
String	ogreSkeletonName (Mesh::MeshdataPtr md, TextureBindingsMapPtr bindings)
String	ogreLightName (const String &entityname, const String &meshname, int32 light_idx)
template<class Functor >
bool	forEachTexture (const Ogre::MaterialPtr &material, Functor func)
char *	findMem (char *data, size_t howmuch, const char *target, size_t targlen)
template<class MemoryBuffer >
bool	tnext_eol (const MemoryBuffer &input, typename MemoryBuffer::size_type &where_lexeme_start)
bool	next_eol (const MemoryBuffer &input, MemoryBuffer::size_type &where_lexeme_start)
bool	next_eol (const Ogre::String &input, Ogre::String::size_type &where_lexeme_start)
Ogre::String &	unreplaceColonSlashSlash (Ogre::String &input)
Ogre::String &	replaceColonSlashSlash (Ogre::String &input)
Ogre::String::size_type	find_space_colon_space (const Ogre::String &input, Ogre::String::size_type start)
float	clamp01 (float input)
Vector3f	pixelToDirection (Camera *cam, float xPixel, float yPixel)
Vector3f	direction (Quaternion cameraAngle)

---

Detailed Description

Namespace for the OGRE Graphics Plugin: see class OgreSystem.

---

Typedef Documentation

typedef std::tr1::shared_ptr< Entity > Sirikata::Graphics::EntityPtr

typedef std::tr1::function<boost::any (WebView*, const JSArguments&) Sirikata::Graphics::JSDelegate)

Delegate for method calls from JS -> C++.

If the call is synchronous, the value will be translated to a JS value if possible.

typedef std::tr1::shared_ptr< ParseMeshTaskInfo > Sirikata::Graphics::ParseMeshTaskHandle

typedef std::tr1::shared_ptr<PriorityDownloadPlannerMetric> Sirikata::Graphics::PriorityDownloadPlannerMetricPtr

typedef std::tr1::shared_ptr<Skybox> Sirikata::Graphics::SkyboxPtr

typedef std::tr1::weak_ptr<Skybox> Sirikata::Graphics::SkyboxWPtr

typedef std::map< String, String > Sirikata::Graphics::TextureBindingsMap

typedef std::tr1::shared_ptr< TextureBindingsMap > Sirikata::Graphics::TextureBindingsMapPtr

---

Enumeration Type Documentation

enum Sirikata::Graphics::MouseButtonID

Enumerates internal mouse button IDs.

Used by WebViewManager::injectMouseDown, WebViewManager::injectMouseUp

Enumerator:

LeftMouseButton
RightMouseButton
MiddleMouseButton
ScrollUpButton
ScrollDownButton
UnknownMouseButton

enum Sirikata::Graphics::Tier

An enumeration of the three tiers ViewportOverlays can reside in.

Enumerator:

TIER_BACK
TIER_MIDDLE
TIER_FRONT

---

Function Documentation

float Sirikata::Graphics::clamp01

(

float

input

)

Referenced by Sirikata::Graphics::CubeMap::updateBlendState().

float Sirikata::Graphics::computeClosestPower	(	const Color &	source,
		const Color &	target,
		float32	power
	)		[inline]

Referenced by updateOgreLight().

Ogre::Light* Sirikata::Graphics::constructOgreLight	(	Ogre::SceneManager *	mgr,
		const String &	name,
		const LightInfo &	linfo
	)		[inline]

References updateOgreLight().

Referenced by Sirikata::Graphics::OgreRenderer::constructSystemLight().

Vector3f Sirikata::Graphics::direction

(

Quaternion

cameraAngle

)

[inline]

References Sirikata::Quaternion::zAxis().

Referenced by Sirikata::Input::SDLJoystick::getButtonName().

Ogre::String::size_type Sirikata::Graphics::find_space_colon_space	(	const Ogre::String &	input,
		Ogre::String::size_type	start
	)

Referenced by Sirikata::Graphics::ReplacingDataStream::replaceData().

char* Sirikata::Graphics::findMem	(	char *	data,
		size_t	howmuch,
		const char *	target,
		size_t	targlen
	)

template<class Functor >

bool Sirikata::Graphics::forEachTexture	(	const Ogre::MaterialPtr &	material,
		Functor	func
	)

Referenced by Sirikata::Graphics::Entity::fixTextures().

Sirikata::Quaternion Sirikata::Graphics::fromOgre

(

const Ogre::Quaternion &

quat

)

[inline]

Referenced by Sirikata::Graphics::Entity::getOgreOrientation(), Sirikata::Graphics::Entity::getOgrePosition(), Sirikata::Graphics::Camera::getOrientation(), Sirikata::Graphics::Camera::getPosition(), and Sirikata::Graphics::OgreSystem::internalRayTrace().

Sirikata::Vector3f Sirikata::Graphics::fromOgre

(

const Ogre::Vector3 &

pos

)

[inline]

Sirikata::Vector3d Sirikata::Graphics::fromOgre	(	const Ogre::Vector3 &	pos,
		const Vector3d &	base
	)		[inline]

Sirikata::Vector4f Sirikata::Graphics::fromOgre

(

const Ogre::Vector4 &

pos

)

[inline]

Sirikata::Color Sirikata::Graphics::fromOgreRGB

(

const Ogre::ColourValue &

rgba

)

[inline]

Sirikata::ColorAlpha Sirikata::Graphics::fromOgreRGBA

(

const Ogre::ColourValue &

rgba

)

[inline]

bool Sirikata::Graphics::next_eol	(	const MemoryBuffer &	input,
		MemoryBuffer::size_type &	where_lexeme_start
	)

References tnext_eol().

Referenced by Sirikata::Graphics::ReplacingDataStream::replaceData().

bool Sirikata::Graphics::next_eol	(	const Ogre::String &	input,
		Ogre::String::size_type &	where_lexeme_start
	)

References tnext_eol().

String Sirikata::Graphics::ogreBillboardMaterialName

(

TextureBindingsMapPtr

bindings

)

References Sirikata::SHA256::computeDigest(), and Sirikata::SHA256::toString().

Referenced by Sirikata::Graphics::PriorityDownloadPlanner::loadBillboard().

String Sirikata::Graphics::ogreLightName	(	const String &	entityname,
		const String &	meshname,
		int32	light_idx
	)

String Sirikata::Graphics::ogreMaterialName	(	const Mesh::MaterialEffectInfo &	mat,
		const Transfer::URI &	parent_uri,
		TextureBindingsMapPtr	bindings
	)

References Sirikata::Mesh::MaterialEffectInfo::Texture::affecting, Sirikata::Mesh::MaterialEffectInfo::Texture::color, Sirikata::SHA256::computeDigest(), Sirikata::Transfer::URL::context(), Sirikata::Transfer::URL::empty(), Sirikata::Mesh::MaterialEffectInfo::Texture::maxMipLevel, Sirikata::Mesh::MaterialEffectInfo::Texture::mipBias, Sirikata::Mesh::MaterialEffectInfo::reflectivity, Sirikata::Mesh::MaterialEffectInfo::shininess, Sirikata::Mesh::MaterialEffectInfo::Texture::texCoord, Sirikata::Mesh::MaterialEffectInfo::textures, Sirikata::JS::JSPresence::toString(), Sirikata::Mesh::MaterialEffectInfo::Texture::uri, url, Sirikata::Mesh::MaterialEffectInfo::Texture::wrapS, Sirikata::Mesh::MaterialEffectInfo::Texture::wrapT, and Sirikata::Mesh::MaterialEffectInfo::Texture::wrapU.

Referenced by Sirikata::Graphics::PriorityDownloadPlanner::loadMeshdata(), and Sirikata::Graphics::ManualMeshLoader::traverseNodes().

String Sirikata::Graphics::ogreSkeletonName	(	Mesh::MeshdataPtr	md,
		TextureBindingsMapPtr	bindings
	)

References ogreVisualName().

Referenced by Sirikata::Graphics::PriorityDownloadPlanner::loadMeshdata().

String Sirikata::Graphics::ogreVisualName	(	Mesh::VisualPtr	vis,
		TextureBindingsMapPtr	bindings
	)

References Sirikata::SHA256::computeDigest(), and Sirikata::SHA256::toString().

Referenced by Sirikata::Graphics::PriorityDownloadPlanner::loadBillboard(), Sirikata::Graphics::PriorityDownloadPlanner::loadMeshdata(), and ogreSkeletonName().

Vector3f Sirikata::Graphics::pixelToDirection	(	Camera *	cam,
		float	xPixel,
		float	yPixel
	)

References Sirikata::Graphics::Camera::getOgreCamera(), Sirikata::Graphics::Camera::getOrientation(), Sirikata::Quaternion::xAxis(), Sirikata::Quaternion::yAxis(), and Sirikata::Quaternion::zAxis().

Referenced by Sirikata::Graphics::OgreSystemInputHandler::hoverEntity().

Ogre::String& Sirikata::Graphics::replaceColonSlashSlash

(

Ogre::String &

input

)

Referenced by Sirikata::Graphics::ReplacingDataStream::full_replace_lexeme(), and Sirikata::Graphics::ReplacingDataStream::replace_lexeme().

template<class MemoryBuffer >

bool Sirikata::Graphics::tnext_eol	(	const MemoryBuffer &	input,
		typename MemoryBuffer::size_type &	where_lexeme_start
	)

Referenced by next_eol().

Ogre::Vector3 Sirikata::Graphics::toOgre	(	const Sirikata::Vector3d &	pos,
		const Sirikata::Vector3d &	base
	)		[inline]

Ogre::Quaternion Sirikata::Graphics::toOgre

(

const Sirikata::Quaternion &

quat

)

[inline]

References Sirikata::Vector4< scalar >::w, Sirikata::Vector4< scalar >::x, Sirikata::Vector4< scalar >::y, and Sirikata::Vector4< scalar >::z.

Referenced by Sirikata::Graphics::OgreRenderer::constructSystemLight(), Sirikata::Graphics::CubeMap::frameEnded(), Sirikata::Graphics::OgreSystemInputHandler::hoverEntity(), Sirikata::Graphics::OgreSystem::queryRay(), Sirikata::Graphics::OgreSystem::rayTrace(), Sirikata::Graphics::Entity::setOgreOrientation(), Sirikata::Graphics::Entity::setOgrePosition(), Sirikata::Graphics::Camera::setOrientation(), Sirikata::Graphics::Camera::setPosition(), and Sirikata::Graphics::ManualMeshLoader::traverseNodes().

Ogre::Vector3 Sirikata::Graphics::toOgre

(

const Sirikata::Vector3f &

pos

)

[inline]

Ogre::Vector4 Sirikata::Graphics::toOgre

(

const Sirikata::Vector4f &

pos

)

[inline]

Ogre::ColourValue Sirikata::Graphics::toOgreRGB

(

const Sirikata::Color &

rgb

)

[inline]

Ogre::ColourValue Sirikata::Graphics::toOgreRGBA

(

const Sirikata::ColorAlpha &

rgba

)

[inline]

Referenced by updateOgreLight().

Ogre::ColourValue Sirikata::Graphics::toOgreRGBA	(	const Sirikata::Color &	rgb,
		float32	alpha
	)		[inline]

Ogre::String& Sirikata::Graphics::unreplaceColonSlashSlash

(

Ogre::String &

input

)

void Sirikata::Graphics::updateOgreLight	(	Ogre::Light *	light,
		const LightInfo &	linfo
	)		[inline]

References computeClosestPower(), Sirikata::LightInfo::DIRECTIONAL, Sirikata::LightInfo::mAmbientColor, Sirikata::LightInfo::mCastsShadow, Sirikata::LightInfo::mConeFalloff, Sirikata::LightInfo::mConeInnerRadians, Sirikata::LightInfo::mConeOuterRadians, Sirikata::LightInfo::mConstantFalloff, Sirikata::LightInfo::mDiffuseColor, Sirikata::LightInfo::mLightRange, Sirikata::LightInfo::mLinearFalloff, Sirikata::LightInfo::mPower, Sirikata::LightInfo::mQuadraticFalloff, Sirikata::LightInfo::mShadowColor, Sirikata::LightInfo::mSpecularColor, Sirikata::LightInfo::mType, Sirikata::LightInfo::POINT, Sirikata::LightInfo::SPOTLIGHT, and toOgreRGBA().

Referenced by constructOgreLight().