Urho3D::Geometry Class Reference

Defines one or more vertex buffers, an index buffer and a draw range. More...

#include <Geometry.h>

Inheritance diagram for Urho3D::Geometry:

Collaboration diagram for Urho3D::Geometry:

Public Member Functions
	Geometry (Context *context)
	Construct with one empty vertex buffer.
virtual	~Geometry ()
	Destruct.
bool	SetNumVertexBuffers (unsigned num)
	Set number of vertex buffer.
bool	SetVertexBuffer (unsigned index, VertexBuffer *buffer, unsigned elementMask=MASK_DEFAULT)
	Set a vertex buffer by index.
void	SetIndexBuffer (IndexBuffer *buffer)
	Set the index buffer.
bool	SetDrawRange (PrimitiveType type, unsigned indexStart, unsigned indexCount, bool getUsedVertexRange=true)
	Set the draw range.
bool	SetDrawRange (PrimitiveType type, unsigned indexStart, unsigned indexCount, unsigned vertexStart, unsigned vertexCount, bool checkIllegal=true)
	Set the draw range.
void	SetLodDistance (float distance)
	Set the LOD distance.
void	SetRawVertexData (SharedArrayPtr< unsigned char > data, unsigned vertexSize, unsigned elementMask)
	Override raw vertex data to be returned for CPU-side operations.
void	SetRawIndexData (SharedArrayPtr< unsigned char > data, unsigned indexSize)
	Override raw index data to be returned for CPU-side operations.
void	Draw (Graphics *graphics)
	Draw.
const Vector< SharedPtr < VertexBuffer > > &	GetVertexBuffers () const
	Return all vertex buffers.
const PODVector< unsigned > &	GetVertexElementMasks () const
	Return vertex element masks.
unsigned	GetNumVertexBuffers () const
	Return number of vertex buffers.
VertexBuffer *	GetVertexBuffer (unsigned index) const
	Return vertex buffer by index.
unsigned	GetVertexElementMask (unsigned index) const
	Return vertex element mask by index.
IndexBuffer *	GetIndexBuffer () const
	Return the index buffer.
PrimitiveType	GetPrimitiveType () const
	Return primitive type.
unsigned	GetIndexStart () const
	Return start index.
unsigned	GetIndexCount () const
	Return number of indices.
unsigned	GetVertexStart () const
	Return first used vertex.
unsigned	GetVertexCount () const
	Return number of used vertices.
float	GetLodDistance () const
	Return LOD distance.
unsigned short	GetBufferHash () const
	Return buffers' combined hash value for state sorting.
void	GetRawData (const unsigned char *&vertexData, unsigned &vertexSize, const unsigned char *&indexData, unsigned &indexSize, unsigned &elementMask) const
	Return raw vertex and index data for CPU operations, or null pointers if not available.
void	GetRawDataShared (SharedArrayPtr< unsigned char > &vertexData, unsigned &vertexSize, SharedArrayPtr< unsigned char > &indexData, unsigned &indexSize, unsigned &elementMask) const
	Return raw vertex and index data for CPU operations, or null pointers if not available.
float	GetHitDistance (const Ray &ray, Vector3 *outNormal=0) const
	Return ray hit distance or infinity if no hit. Requires raw data to be set. Optionally return hit normal.
bool	IsInside (const Ray &ray) const
	Return whether or not the ray is inside geometry.
bool	IsEmpty () const
	Return whether has empty draw range.
Public Member Functions inherited from Urho3D::Object
	Object (Context *context)
	Construct.
virtual	~Object ()
	Destruct. Clean up self from event sender & receiver structures.
virtual Urho3D::StringHash	GetType () const =0
	Return type hash.
virtual Urho3D::StringHash	GetBaseType () const =0
	Return base class type hash.
virtual const Urho3D::String &	GetTypeName () const =0
	Return type name.
virtual void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.
void	SubscribeToEvent (StringHash eventType, EventHandler *handler)
	Subscribe to an event that can be sent by any sender.
void	SubscribeToEvent (Object *sender, StringHash eventType, EventHandler *handler)
	Subscribe to a specific sender's event.
void	UnsubscribeFromEvent (StringHash eventType)
	Unsubscribe from an event.
void	UnsubscribeFromEvent (Object *sender, StringHash eventType)
	Unsubscribe from a specific sender's event.
void	UnsubscribeFromEvents (Object *sender)
	Unsubscribe from a specific sender's events.
void	UnsubscribeFromAllEvents ()
	Unsubscribe from all events.
void	UnsubscribeFromAllEventsExcept (const PODVector< StringHash > &exceptions, bool onlyUserData)
	Unsubscribe from all events except those listed, and optionally only those with userdata (script registered events.)
void	SendEvent (StringHash eventType)
	Send event to all subscribers.
void	SendEvent (StringHash eventType, VariantMap &eventData)
	Send event with parameters to all subscribers. More...
VariantMap &	GetEventDataMap () const
	Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
Context *	GetContext () const
	Return execution context.
Object *	GetSubsystem (StringHash type) const
	Return subsystem by type.
Object *	GetEventSender () const
	Return active event sender. Null outside event handling.
EventHandler *	GetEventHandler () const
	Return active event handler. Null outside event handling.
bool	HasSubscribedToEvent (StringHash eventType) const
	Return whether has subscribed to an event without specific sender.
bool	HasSubscribedToEvent (Object *sender, StringHash eventType) const
	Return whether has subscribed to a specific sender's event.
bool	HasEventHandlers () const
	Return whether has subscribed to any event.
template<class T >
T *	GetSubsystem () const
	Template version of returning a subsystem.
const String &	GetCategory () const
	Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
Public Member Functions inherited from Urho3D::RefCounted
	RefCounted ()
	Construct. Allocate the reference count structure and set an initial self weak reference.
virtual	~RefCounted ()
	Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
void	AddRef ()
	Increment reference count. Can also be called outside of a SharedPtr for traditional reference counting.
void	ReleaseRef ()
	Decrement reference count and delete self if no more references. Can also be called outside of a SharedPtr for traditional reference counting.
int	Refs () const
	Return reference count.
int	WeakRefs () const
	Return weak reference count.
RefCount *	RefCountPtr ()
	Return pointer to the reference count structure.

Private Member Functions
	OBJECT (Geometry)
void	GetPositionBufferIndex ()
	Locate vertex buffer with position data.

Private Attributes
Vector< SharedPtr< VertexBuffer > >	vertexBuffers_
	Vertex buffers.
PODVector< unsigned >	elementMasks_
	Vertex element masks.
SharedPtr< IndexBuffer >	indexBuffer_
	Index buffer.
SharedArrayPtr< unsigned char >	rawVertexData_
	Raw vertex data override.
SharedArrayPtr< unsigned char >	rawIndexData_
	Raw index data override.
PrimitiveType	primitiveType_
	Primitive type.
unsigned	indexStart_
	Start index.
unsigned	indexCount_
	Number of indices.
unsigned	vertexStart_
	First used vertex.
unsigned	vertexCount_
	Number of used vertices.
unsigned	positionBufferIndex_
	Index of vertex buffer with position data.
unsigned	rawVertexSize_
	Raw vertex data override size.
unsigned	rawElementMask_
	Raw vertex data override element mask.
unsigned	rawIndexSize_
	Raw index data override size.
float	lodDistance_
	LOD distance.

Additional Inherited Members
Protected Attributes inherited from Urho3D::Object
Context *	context_
	Execution context.

Detailed Description

Defines one or more vertex buffers, an index buffer and a draw range.

---

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

• /home/travis/build/urho3d/Urho3D/Source/Urho3D/Graphics/Geometry.h
• /home/travis/build/urho3d/Urho3D/Source/Urho3D/Graphics/Geometry.cpp