3D model resource. More...

#include <Urho3D/Graphics/Model.h>

Inheritance diagram for Urho3D::Model:

Public Member Functions
	Model (Context *context)
	Construct.

	~Model () override
	Destruct.

bool	BeginLoad (Deserializer &source) override
	Load resource from stream. May be called from a worker thread. Return true if successful.

bool	EndLoad () override
	Finish resource loading. Always called from the main thread. Return true if successful.

bool	Save (Serializer &dest) const override
	Save resource. Return true if successful.

void	SetBoundingBox (const BoundingBox &box)

bool	SetVertexBuffers (const ea::vector< SharedPtr< VertexBuffer > > &buffers, const ea::vector< unsigned > &morphRangeStarts, const ea::vector< unsigned > &morphRangeCounts)
	Set vertex buffers and their morph ranges.

bool	SetIndexBuffers (const ea::vector< SharedPtr< IndexBuffer > > &buffers)
	Set index buffers.

void	SetNumGeometries (unsigned num)

bool	SetNumGeometryLodLevels (unsigned index, unsigned num)

bool	SetGeometry (unsigned index, unsigned lodLevel, Geometry *geometry)
	Set geometry.

bool	SetGeometryCenter (unsigned index, const Vector3 &center)

void	SetSkeleton (const Skeleton &skeleton)
	Set skeleton.

void	SetGeometryBoneMappings (const ea::vector< ea::vector< unsigned > > &geometryBoneMappings)
	Set bone mappings when model has more bones than the skinning shader can handle.

void	SetMorphs (const ea::vector< ModelMorph > &morphs)
	Set vertex morphs.

SharedPtr< Model >	Clone (const ea::string &cloneName=EMPTY_STRING) const
	Clone the model. The geometry data is deep-copied and can be modified in the clone without affecting the original.

const BoundingBox &	GetBoundingBox () const

Skeleton &	GetSkeleton ()

const Skeleton &	GetSkeleton () const
	Return skeleton.

const ea::vector< SharedPtr< VertexBuffer > > &	GetVertexBuffers () const
	Return vertex buffers.

const ea::vector< SharedPtr< IndexBuffer > > &	GetIndexBuffers () const
	Return index buffers.

unsigned	GetNumGeometries () const

unsigned	GetNumGeometryLodLevels (unsigned index) const

const ea::vector< ea::vector< SharedPtr< Geometry > > > &	GetGeometries () const
	Return geometry pointers.

const ea::vector< Vector3 > &	GetGeometryCenters () const
	Return geometry center points.

Geometry *	GetGeometry (unsigned index, unsigned lodLevel) const
	Return geometry by index and LOD level. The LOD level is clamped if out of range.

const Vector3 &	GetGeometryCenter (unsigned index) const

const ea::vector< ea::vector< unsigned > > &	GetGeometryBoneMappings () const
	Return geometery bone mappings.

const ea::vector< ModelMorph > &	GetMorphs () const
	Return vertex morphs.

unsigned	GetNumMorphs () const

const ModelMorph *	GetMorph (unsigned index) const
	Return vertex morph by index.

const ModelMorph *	GetMorph (const ea::string &name) const
	Return vertex morph by name.

const ModelMorph *	GetMorph (StringHash nameHash) const
	Return vertex morph by name hash.

unsigned	GetMorphRangeStart (unsigned bufferIndex) const
	Return vertex buffer morph range start.

unsigned	GetMorphRangeCount (unsigned bufferIndex) const
	Return vertex buffer morph range vertex count.

const ea::vector< unsigned > &	GetMorphRangeStarts () const
	Return morph range starts for each vertex buffer.

const ea::vector< unsigned > &	GetMorphRangeCounts () const
	Return morph range vertex counts for each vertex buffer.

Public Member Functions inherited from Urho3D::ResourceWithMetadata
	ResourceWithMetadata (Context *context)
	Construct.

void	AddMetadata (const ea::string &name, const Variant &value)

void	RemoveMetadata (const ea::string &name)
	Remove metadata variable.

void	RemoveAllMetadata ()
	Remove all metadata variables.

const StringVector &	GetMetadataKeys () const
	Return all metadata keys.

const Variant &	GetMetadata (const ea::string &name) const

bool	HasMetadata () const

Public Member Functions inherited from Urho3D::Resource
	Resource (Context *context)
	Construct.

bool	Load (Deserializer &source)
	Load resource synchronously. Call both BeginLoad() & EndLoad() and return true if both succeeded.

bool	LoadFile (const FileIdentifier &fileName)
	Load resource from file.

virtual bool	SaveFile (const FileIdentifier &fileName) const
	Save resource to file.

void	SetName (const ea::string &name)

void	SetMemoryUse (unsigned size)
	Set memory use in bytes, possibly approximate.

void	ResetUseTimer ()
	Reset last used timer.

void	SetAsyncLoadState (AsyncLoadState newState)
	Set the asynchronous loading state. Called by ResourceCache. Resources in the middle of asynchronous loading are not normally returned to user.

void	SetAbsoluteFileName (const ea::string &fileName)
	Set absolute file name.

const ea::string &	GetName () const

StringHash	GetNameHash () const
	Return name hash.

unsigned	GetMemoryUse () const

unsigned	GetUseTimer ()

AsyncLoadState	GetAsyncLoadState () const
	Return the asynchronous loading state.

const ea::string &	GetAbsoluteFileName () const
	Return absolute file name.

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

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, const Args &... args)
	Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.

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 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.

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

int	AddRef ()

int	ReleaseRef ()

int	Refs () const

int	WeakRefs () const

RefCount *	RefCountPtr () 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.

Static Public Member Functions
static void	RegisterObject (Context *context)

Static Public Member Functions inherited from Urho3D::Resource
static Resource *	LoadFromCache (Context *context, StringHash type, const ea::string &name)
	Load resource by reference.

Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Private Member Functions
	URHO3D_OBJECT (Model, ResourceWithMetadata)

Private Attributes
BoundingBox	boundingBox_
	Bounding box.

Skeleton	skeleton_
	Skeleton.

ea::vector< SharedPtr< VertexBuffer > >	vertexBuffers_
	Vertex buffers.

ea::vector< SharedPtr< IndexBuffer > >	indexBuffers_
	Index buffers.

ea::vector< ea::vector< SharedPtr< Geometry > > >	geometries_
	Geometries.

ea::vector< ea::vector< unsigned > >	geometryBoneMappings_
	Geometry bone mappings.

ea::vector< Vector3 >	geometryCenters_
	Geometry centers.

ea::vector< ModelMorph >	morphs_
	Vertex morphs.

ea::vector< unsigned >	morphRangeStarts_
	Vertex buffer morph range start.

ea::vector< unsigned >	morphRangeCounts_
	Vertex buffer morph range vertex count.

ea::vector< VertexBufferDesc >	loadVBData_
	Vertex buffer data for asynchronous loading.

ea::vector< IndexBufferDesc >	loadIBData_
	Index buffer data for asynchronous loading.

ea::vector< ea::vector< GeometryDesc > >	loadGeometries_
	Geometry definitions for asynchronous loading.

Static Private Attributes

static const unsigned	legacyVersion = 1

static const unsigned	morphWeightVersion = 2

static const unsigned	currentVersion = morphWeightVersion

Additional Inherited Members
Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}

Protected Member Functions inherited from Urho3D::ResourceWithMetadata
void	LoadMetadataFromXML (const XMLElement &source)
	Load metadata from <metadata> children of XML element.

void	LoadMetadataFromJSON (const JSONArray &array)
	Load metadata from JSON array.

void	SaveMetadataToXML (XMLElement &destination) const
	Save as <metadata> children of XML element.

void	CopyMetadata (const ResourceWithMetadata &source)
	Copy metadata from another resource.

Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Detailed Description

3D model resource.

Member Function Documentation

◆ BeginLoad()

bool Urho3D::Model::BeginLoad ( Deserializer & source )

overridevirtual

Load resource from stream. May be called from a worker thread. Return true if successful.

Reimplemented from Urho3D::Resource.

◆ EndLoad()

bool Urho3D::Model::EndLoad ( )

overridevirtual

Finish resource loading. Always called from the main thread. Return true if successful.

Reimplemented from Urho3D::Resource.

◆ GetBoundingBox()

const BoundingBox & Urho3D::Model::GetBoundingBox ( ) const

inline

Return bounding box.

◆ GetGeometryCenter()

const Vector3 & Urho3D::Model::GetGeometryCenter ( unsigned index ) const

inline

Return geometry center by index.

◆ GetNumGeometries()

unsigned Urho3D::Model::GetNumGeometries ( ) const

inline

Return number of geometries.

◆ GetNumGeometryLodLevels()

unsigned Urho3D::Model::GetNumGeometryLodLevels ( unsigned index ) const

Return number of LOD levels in geometry.

◆ GetNumMorphs()

unsigned Urho3D::Model::GetNumMorphs ( ) const

inline

Return number of vertex morphs.

◆ GetSkeleton()

Skeleton & Urho3D::Model::GetSkeleton ( )

inline

Return skeleton.

◆ RegisterObject()

void Urho3D::Model::RegisterObject ( Context * context )

static

Register object factory.

◆ Save()

bool Urho3D::Model::Save ( Serializer & dest ) const

overridevirtual

Save resource. Return true if successful.

Reimplemented from Urho3D::Resource.

◆ SetBoundingBox()

void Urho3D::Model::SetBoundingBox ( const BoundingBox & box )

Set local-space bounding box.

◆ SetGeometryCenter()

bool Urho3D::Model::SetGeometryCenter	(	unsigned	index,
		const Vector3 &	center
	)

Set geometry center.

◆ SetNumGeometries()

void Urho3D::Model::SetNumGeometries ( unsigned num )

Set number of geometries.

◆ SetNumGeometryLodLevels()

bool Urho3D::Model::SetNumGeometryLodLevels	(	unsigned	index,
		unsigned	num
	)

Set number of LOD levels in a geometry.

Member Data Documentation

◆ legacyVersion

const unsigned Urho3D::Model::legacyVersion = 1

staticprivate

Class versions (used for serialization)

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

Urho3D/Graphics/Model.h
Urho3D/Graphics/Model.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ BeginLoad()

◆ EndLoad()

◆ GetBoundingBox()

◆ GetGeometryCenter()

◆ GetNumGeometries()

◆ GetNumGeometryLodLevels()

◆ GetNumMorphs()

◆ GetSkeleton()

◆ RegisterObject()

◆ Save()

◆ SetBoundingBox()

◆ SetGeometryCenter()

◆ SetNumGeometries()

◆ SetNumGeometryLodLevels()

Member Data Documentation

◆ legacyVersion