Rebel Fork Framework
Urho3D::Geometry Class Reference

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

#include <Urho3D/Graphics/Geometry.h>

Inheritance diagram for Urho3D::Geometry:
Urho3D::Object Urho3D::PipelineStateTracker Urho3D::IDFamily< Geometry > Urho3D::RefCounted

Public Member Functions

 Geometry (Context *context)
 Construct with one empty vertex buffer.
 
 ~Geometry () override
 Destruct.
 
bool SetNumVertexBuffers (unsigned num)
 
bool SetVertexBuffer (unsigned index, VertexBuffer *buffer)
 Set a vertex buffer by index.
 
void SetVertexBuffers (const ea::vector< SharedPtr< VertexBuffer >> &vertexBuffers)
 Set all vertex buffers at once.
 
void SetIndexBuffer (IndexBuffer *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)
 
void SetRawVertexData (const ea::shared_array< unsigned char > &data, const ea::vector< VertexElement > &elements)
 Override raw vertex data to be returned for CPU-side operations.
 
void SetRawVertexData (const ea::shared_array< unsigned char > &data, unsigned elementMask)
 Override raw vertex data to be returned for CPU-side operations using a legacy vertex bitmask.
 
void SetRawIndexData (const ea::shared_array< unsigned char > &data, unsigned indexSize)
 Override raw index data to be returned for CPU-side operations.
 
const ea::vector< SharedPtr< VertexBuffer > > & GetVertexBuffers () const
 Return all vertex buffers.
 
unsigned GetNumVertexBuffers () const
 
VertexBufferGetVertexBuffer (unsigned index) const
 
IndexBufferGetIndexBuffer () const
 
PrimitiveType GetPrimitiveType () const
 
unsigned GetIndexStart () const
 
unsigned GetIndexCount () const
 
unsigned GetVertexStart () const
 
unsigned GetVertexCount () const
 
float GetLodDistance () const
 
unsigned GetEffectiveIndexCount () const
 Return index or vertex count depending on whether the index buffer is used.
 
unsigned GetPrimitiveCount () const
 Return number of primitives.
 
void GetRawData (const unsigned char *&vertexData, unsigned &vertexSize, const unsigned char *&indexData, unsigned &indexSize, const ea::vector< 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 (ea::shared_array< unsigned char > &vertexData, unsigned &vertexSize, ea::shared_array< unsigned char > &indexData, unsigned &indexSize, const ea::vector< 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
 
bool IsInstanced (GeometryType geometryType) const
 Return whether the geometry can be rendered using instancing buffer.
 
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 Construct.
 
 ~Object () override
 Destruct. Clean up self from event sender & receiver structures.
 
virtual StringHash GetType () const =0
 
virtual const ea::string & GetTypeName () const =0
 
virtual const TypeInfoGetTypeInfo () const =0
 Return type info.
 
virtual bool IsInstanceOf (StringHash type) const =0
 Check whether current instance implements specified type.
 
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
 
virtual void SerializeInBlock (Archive &archive)
 Serialize content from/to archive. May throw ArchiveException.
 
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 SubscribeToEventManual (StringHash eventType, EventHandler *handler)
 Subscribe to an event that can be sent by any sender.
 
void SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
 Subscribe to a specific sender's event.
 
template<class T >
void SubscribeToEvent (StringHash eventType, T handler)
 Subscribe to an event that can be sent by any sender.
 
template<class T >
void SubscribeToEvent (Object *sender, StringHash eventType, T 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 ea::vector< StringHash > &exceptions)
 Unsubscribe from all events except those listed.
 
void UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
 Unsubscribe from all events except those with listed senders.
 
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, const Args &... args)
 Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
 
ContextGetContext () const
 Return execution context.
 
const VariantGetGlobalVar (StringHash key) const
 
const VariantMapGetGlobalVars () const
 
void SetGlobalVar (StringHash key, const Variant &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 ea::string & GetCategory () const
 
void SendEvent (StringHash eventType, const VariantMap &eventData)
 Send event with parameters to all subscribers.
 
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.
 
 RefCounted (const RefCounted &rhs)=delete
 Prevent copy construction.
 
RefCountedoperator= (const RefCounted &rhs)=delete
 Prevent assignment.
 
int AddRef ()
 
int ReleaseRef ()
 
int Refs () const
 
int WeakRefs () const
 
RefCountRefCountPtr () const
 Return pointer to the reference count structure.
 
bool HasScriptObject () const
 Return true if script runtime object wrapping this native object exists.
 
bool IsScriptStrongRef () const
 Return true if script reference is strong.
 
- Public Member Functions inherited from Urho3D::PipelineStateTracker
virtual ~PipelineStateTracker ()
 Destruct.
 
unsigned GetPipelineStateHash () const
 Return (partial) pipeline state hash. Save to call from multiple threads as long as the object is not changing.
 
void MarkPipelineStateHashDirty ()
 Mark pipeline state hash as dirty.
 
- Public Member Functions inherited from Urho3D::IDFamily< Geometry >
 IDFamily ()
 Construct.
 
 ~IDFamily ()
 Destruct.
 
unsigned GetObjectID () const
 Return unique object ID or 0 if not assigned.
 
void AcquireObjectID ()
 Acquire unique object ID. Ignored if unique ID is already acquired.
 
void ReleaseObjectID ()
 Release unique object ID. Ignored if unique ID is already released.
 

Static Public Member Functions

static void RegisterObject (Context *context)
 Register object with the engine.
 
- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.
 
- Static Public Member Functions inherited from Urho3D::IDFamily< Geometry >
static const unsigned GetNextFreeObjectID ()
 Return upper bound of all used object IDs within family.
 

Private Member Functions

 URHO3D_OBJECT (Geometry, Object)
 
unsigned RecalculatePipelineStateHash () const override
 Recalculate hash. Shall be save to call from multiple threads as long as the object is not changing.
 

Private Attributes

ea::vector< SharedPtr< VertexBuffer > > vertexBuffers_
 Vertex buffers.
 
ea::vector< PipelineStateSubscriptionvertexBuffersDependencies_
 Vertex buffers dependencies.
 
SharedPtr< IndexBufferindexBuffer_
 Index buffer.
 
PipelineStateSubscription indexBufferDependency_
 Index buffer dependency.
 
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.
 
ea::vector< VertexElementrawElements_
 Raw vertex data elements.
 
ea::shared_array< unsigned char > rawVertexData_
 Raw vertex data override.
 
ea::shared_array< 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 Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 > TypeHierarchy {}
 
- Protected Member Functions inherited from Urho3D::PipelineStateTracker
PipelineStateSubscription CreateDependency (PipelineStateTracker *dependency)
 Create dependency onto another pipeline state.
 
void AddSubscriberReference (PipelineStateTracker *subscriber)
 Add reference to subscriber pipeline state tracker.
 
void RemoveSubscriberReference (PipelineStateTracker *subscriber)
 Remove reference to subscriber pipeline state tracker.
 
- Protected Attributes inherited from Urho3D::Object
WeakPtr< Contextcontext_
 Execution context.
 

Detailed Description

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

Member Function Documentation

◆ GetIndexBuffer()

IndexBuffer* Urho3D::Geometry::GetIndexBuffer ( ) const
inline

Return the index buffer.

◆ GetIndexCount()

unsigned Urho3D::Geometry::GetIndexCount ( ) const
inline

Return number of indices.

◆ GetIndexStart()

unsigned Urho3D::Geometry::GetIndexStart ( ) const
inline

Return start index.

◆ GetLodDistance()

float Urho3D::Geometry::GetLodDistance ( ) const
inline

Return LOD distance.

◆ GetNumVertexBuffers()

unsigned Urho3D::Geometry::GetNumVertexBuffers ( ) const
inline

Return number of vertex buffers.

◆ GetPrimitiveType()

PrimitiveType Urho3D::Geometry::GetPrimitiveType ( ) const
inline

Return primitive type.

◆ GetVertexBuffer()

VertexBuffer * Urho3D::Geometry::GetVertexBuffer ( unsigned  index) const

Return vertex buffer by index.

◆ GetVertexCount()

unsigned Urho3D::Geometry::GetVertexCount ( ) const
inline

Return number of used vertices.

◆ GetVertexStart()

unsigned Urho3D::Geometry::GetVertexStart ( ) const
inline

Return first used vertex.

◆ IsEmpty()

bool Urho3D::Geometry::IsEmpty ( ) const
inline

Return whether has empty draw range.

◆ SetIndexBuffer()

void Urho3D::Geometry::SetIndexBuffer ( IndexBuffer buffer)

Set the index buffer.

◆ SetLodDistance()

void Urho3D::Geometry::SetLodDistance ( float  distance)

Set the LOD distance.

◆ SetNumVertexBuffers()

bool Urho3D::Geometry::SetNumVertexBuffers ( unsigned  num)

Set number of vertex buffers.


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