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

#include </var/dev/u3d/stable/Source/Urho3D/Graphics/Geometry.h>

Inheritance diagram for Urho3D::Geometry:

Collaboration diagram for Urho3D::Geometry:

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	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 SharedArrayPtr< unsigned char > &data, const PODVector< VertexElement > &elements)
	Override raw vertex data to be returned for CPU-side operations.

void	SetRawVertexData (const SharedArrayPtr< unsigned char > &data, unsigned elementMask)
	Override raw vertex data to be returned for CPU-side operations using a legacy vertex bitmask.

void	SetRawIndexData (const 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

VertexBuffer *	GetVertexBuffer (unsigned index) const

IndexBuffer *	GetIndexBuffer () const

PrimitiveType	GetPrimitiveType () const

unsigned	GetIndexStart () const

unsigned	GetIndexCount () const

unsigned	GetVertexStart () const

unsigned	GetVertexCount () const

float	GetLodDistance () const

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

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 String &	GetTypeName () const =0

virtual const TypeInfo *	GetTypeInfo () 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.

VariantMap &	GetEventDataMap () 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.

Context *	GetContext () const
	Return execution context.

const Variant &	GetGlobalVar (StringHash key) const

const VariantMap &	GetGlobalVars () const

void	SetGlobalVar (StringHash key, const Variant &value)

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

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.

RefCounted &	operator= (const RefCounted &rhs)=delete
	Prevent assignment.

void	AddRef ()

void	ReleaseRef ()

int	Refs () const

int	WeakRefs () const

RefCount *	RefCountPtr ()
	Return pointer to the reference count structure.

Private Member Functions
	URHO3D_OBJECT (Geometry, Object)

Private Attributes
Vector< SharedPtr< VertexBuffer > >	vertexBuffers_
	Vertex buffers.

SharedPtr< IndexBuffer >	indexBuffer_
	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< VertexElement >	rawElements_
	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 TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

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.

Member Function Documentation

◆ GetIndexBuffer()

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

inline

Return the index buffer.

Here is the caller graph for this function:

◆ GetIndexCount()

unsigned Urho3D::Geometry::GetIndexCount ( ) const

inline

Return number of indices.

Here is the caller graph for this function:

◆ GetIndexStart()

unsigned Urho3D::Geometry::GetIndexStart ( ) const

inline

Return start index.

Here is the caller graph for this function:

◆ GetLodDistance()

float Urho3D::Geometry::GetLodDistance ( ) const

inline

Return LOD distance.

Here is the caller graph for this function:

◆ GetNumVertexBuffers()

unsigned Urho3D::Geometry::GetNumVertexBuffers ( ) const

inline

Return number of vertex buffers.

Here is the caller graph for this function:

◆ GetPrimitiveType()

PrimitiveType Urho3D::Geometry::GetPrimitiveType ( ) const

inline

Return primitive type.

Here is the caller graph for this function:

◆ GetVertexBuffer()

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

Return vertex buffer by index.

Here is the caller graph for this function:

◆ GetVertexCount()

unsigned Urho3D::Geometry::GetVertexCount ( ) const

inline

Return number of used vertices.

Here is the caller graph for this function:

◆ GetVertexStart()

unsigned Urho3D::Geometry::GetVertexStart ( ) const

inline

Return first used vertex.

Here is the caller graph for this function:

◆ IsEmpty()

bool Urho3D::Geometry::IsEmpty ( ) const

inline

Return whether has empty draw range.

Here is the caller graph for this function:

◆ SetIndexBuffer()

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

Set the index buffer.

Here is the caller graph for this function:

◆ SetLodDistance()

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

Set the LOD distance.

◆ SetNumVertexBuffers()

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

Set number of vertex buffers.

Here is the caller graph for this function:

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

/var/dev/u3d/stable/Source/Urho3D/Graphics/Geometry.h
/var/dev/u3d/stable/Source/Urho3D/Graphics/Geometry.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetIndexBuffer()

◆ GetIndexCount()

◆ GetIndexStart()

◆ GetLodDistance()

◆ GetNumVertexBuffers()

◆ GetPrimitiveType()

◆ GetVertexBuffer()

◆ GetVertexCount()

◆ GetVertexStart()

◆ IsEmpty()

◆ SetIndexBuffer()

◆ SetLodDistance()

◆ SetNumVertexBuffers()