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

#include <Urho3D/Graphics/Geometry.h>

Inheritance diagram for Urho3D::Geometry:
[legend]
Collaboration diagram for Urho3D::Geometry:
[legend]

Public Member Functions

 Geometry (Context *context)
 Construct with one empty vertex buffer.
 
virtual ~Geometry () override
 Destruct.
 
bool SetNumVertexBuffers (unsigned num)
 Set number of vertex buffers.
 
bool SetVertexBuffer (unsigned index, VertexBuffer *buffer)
 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, const PODVector< VertexElement > &elements)
 Override raw vertex data to be returned for CPU-side operations.
 
void SetRawVertexData (SharedArrayPtr< unsigned char > data, unsigned elementMask)
 Override raw vertex data to be returned for CPU-side operations using a legacy vertex bitmask.
 
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.
 
unsigned GetNumVertexBuffers () const
 Return number of vertex buffers.
 
VertexBufferGetVertexBuffer (unsigned index) const
 Return vertex buffer by index.
 
IndexBufferGetIndexBuffer () 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, const PODVector< VertexElement > *&elements) const
 Return raw vertex and index data for CPU operations, or null pointers if not available. Will return data of the first vertex buffer if override data not set.
 
void GetRawDataShared (SharedArrayPtr< unsigned char > &vertexData, unsigned &vertexSize, SharedArrayPtr< unsigned char > &indexData, unsigned &indexSize, const PODVector< VertexElement > *&elements) const
 Return raw vertex and index data for CPU operations, or null pointers if not available. Will return data of the first vertex buffer if override data not set.
 
float GetHitDistance (const Ray &ray, Vector3 *outNormal=nullptr, Vector2 *outUV=nullptr) const
 Return ray hit distance or infinity if no hit. Requires raw data to be set. Optionally return hit normal and hit uv coordinates at intersect point.
 
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 () override
 Destruct. Clean up self from event sender & receiver structures.
 
virtual StringHash GetType () const =0
 Return type hash.
 
virtual const StringGetTypeName () const =0
 Return type name.
 
virtual const TypeInfoGetTypeInfo () const =0
 Return type info.
 
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
 
bool IsInstanceOf (StringHash type) const
 Check current instance is type of specified type.
 
bool IsInstanceOf (const TypeInfo *typeInfo) const
 Check current instance is type of specified type.
 
template<typename T >
bool IsInstanceOf () const
 Check current instance is type of specified class.
 
template<typename T >
T * Cast ()
 Cast the object to specified most derived class.
 
template<typename T >
const T * Cast () const
 Cast the object to specified most derived class.
 
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 SubscribeToEvent (StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
 Subscribe to an event that can be sent by any sender.
 
void SubscribeToEvent (Object *sender, StringHash eventType, const std::function< void(StringHash, VariantMap &)> &function, void *userData=nullptr)
 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.
 
VariantMapGetEventDataMap () const
 Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
 
template<typename... Args>
void SendEvent (StringHash eventType, Args...args)
 Send event with variadic parameter pairs to all subscribers. The parameter pairs is a list of paramID and paramValue separated by comma, one pair after another.
 
ContextGetContext () const
 Return execution context.
 
const VariantGetGlobalVar (StringHash key) const
 Return global variable based on key.
 
const VariantMapGetGlobalVars () const
 Return all global variables.
 
void SetGlobalVar (StringHash key, const Variant &value)
 Set global variable with the respective key and value.
 
ObjectGetSubsystem (StringHash type) const
 Return subsystem by type.
 
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
 
EventHandlerGetEventHandler () 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 StringGetCategory () const
 Return object category. Categories are (optionally) registered along with the object factory. Return an empty string if the object category is not registered.
 
void SetBlockEvents (bool block)
 Block object from sending and receiving events.
 
bool GetBlockEvents () const
 Return sending and receiving events blocking status.
 
- 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.
 
RefCountRefCountPtr ()
 Return pointer to the reference count structure.
 

Private Member Functions

 URHO3D_OBJECT (Geometry, Object)
 

Private Attributes

Vector< SharedPtr< VertexBuffer > > vertexBuffers_
 Vertex buffers.
 
SharedPtr< IndexBufferindexBuffer_
 Index buffer.
 
PrimitiveType primitiveType_
 Primitive type.
 
unsigned indexStart_
 Start index.
 
unsigned indexCount_
 Number of indices.
 
unsigned vertexStart_
 First used vertex.
 
unsigned vertexCount_
 Number of used vertices.
 
float lodDistance_
 LOD distance.
 
PODVector< VertexElementrawElements_
 Raw vertex data elements.
 
SharedArrayPtr< unsigned char > rawVertexData_
 Raw vertex data override.
 
SharedArrayPtr< unsigned char > rawIndexData_
 Raw index data override.
 
unsigned rawVertexSize_
 Raw vertex data override size.
 
unsigned rawIndexSize_
 Raw index data override size.
 

Additional Inherited Members

- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.
 
- Protected Attributes inherited from Urho3D::Object
Contextcontext_
 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:
  • Source/Urho3D/Graphics/Geometry.h
  • Source/Urho3D/Graphics/Geometry.cpp