3D model resource. More...

#include <Urho3D/Graphics/Model.h>

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

Public Member Functions

 Model (Context *context)
 Construct.
 
virtual ~Model ()
 Destruct.
 
virtual bool BeginLoad (Deserializer &source)
 Load resource from stream. May be called from a worker thread. Return true if successful.
 
virtual bool EndLoad ()
 Finish resource loading. Always called from the main thread. Return true if successful.
 
virtual bool Save (Serializer &dest) const
 Save resource. Return true if successful.
 
void SetBoundingBox (const BoundingBox &box)
 Set local-space bounding box.
 
bool SetVertexBuffers (const Vector< SharedPtr< VertexBuffer > > &buffers, const PODVector< unsigned > &morphRangeStarts, const PODVector< unsigned > &morphRangeCounts)
 Set vertex buffers and their morph ranges.
 
bool SetIndexBuffers (const Vector< SharedPtr< IndexBuffer > > &buffers)
 Set index buffers.
 
void SetNumGeometries (unsigned num)
 Set number of geometries.
 
bool SetNumGeometryLodLevels (unsigned index, unsigned num)
 Set number of LOD levels in a geometry.
 
bool SetGeometry (unsigned index, unsigned lodLevel, Geometry *geometry)
 Set geometry.
 
bool SetGeometryCenter (unsigned index, const Vector3 &center)
 Set geometry center.
 
void SetSkeleton (const Skeleton &skeleton)
 Set skeleton.
 
void SetGeometryBoneMappings (const Vector< PODVector< unsigned > > &mappings)
 Set bone mappings when model has more bones than the skinning shader can handle.
 
void SetMorphs (const Vector< ModelMorph > &morphs)
 Set vertex morphs.
 
SharedPtr< ModelClone (const String &cloneName=String::EMPTY) const
 Clone the model. The geometry data is deep-copied and can be modified in the clone without affecting the original.
 
const BoundingBoxGetBoundingBox () const
 Return bounding box.
 
SkeletonGetSkeleton ()
 Return skeleton.
 
const Vector< SharedPtr
< VertexBuffer > > & 
GetVertexBuffers () const
 Return vertex buffers.
 
const Vector< SharedPtr
< IndexBuffer > > & 
GetIndexBuffers () const
 Return index buffers.
 
unsigned GetNumGeometries () const
 Return number of geometries.
 
unsigned GetNumGeometryLodLevels (unsigned index) const
 Return number of LOD levels in geometry.
 
const Vector< Vector
< SharedPtr< Geometry > > > & 
GetGeometries () const
 Return geometry pointers.
 
const PODVector< Vector3 > & GetGeometryCenters () const
 Return geometry center points.
 
GeometryGetGeometry (unsigned index, unsigned lodLevel) const
 Return geometry by index and LOD level. The LOD level is clamped if out of range.
 
const Vector3GetGeometryCenter (unsigned index) const
 Return geometry center by index.
 
const Vector< PODVector
< unsigned > > & 
GetGeometryBoneMappings () const
 Return geometery bone mappings.
 
const Vector< ModelMorph > & GetMorphs () const
 Return vertex morphs.
 
unsigned GetNumMorphs () const
 Return number of vertex morphs.
 
const ModelMorphGetMorph (unsigned index) const
 Return vertex morph by index.
 
const ModelMorphGetMorph (const String &name) const
 Return vertex morph by name.
 
const ModelMorphGetMorph (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.
 
- 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 String &fileName)
 Load resource from file.
 
virtual bool SaveFile (const String &fileName) const
 Save resource to file.
 
void SetName (const String &name)
 Set 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.
 
const StringGetName () const
 Return name.
 
StringHash GetNameHash () const
 Return name hash.
 
unsigned GetMemoryUse () const
 Return memory use in bytes, possibly approximate.
 
unsigned GetUseTimer ()
 Return time since last use in milliseconds. If referred to elsewhere than in the resource cache, returns always zero.
 
AsyncLoadState GetAsyncLoadState () const
 Return the asynchronous loading state.
 
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 Construct.
 
virtual ~Object ()
 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.
 
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=0)
 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=0)
 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.
 
- 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.
 

Static Public Member Functions

static void RegisterObject (Context *context)
 Register object factory.
 
- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.
 

Private Member Functions

 URHO3D_OBJECT (Model, ResourceWithMetadata)
 

Private Attributes

BoundingBox boundingBox_
 Bounding box.
 
Skeleton skeleton_
 Skeleton.
 
Vector< SharedPtr< VertexBuffer > > vertexBuffers_
 Vertex buffers.
 
Vector< SharedPtr< IndexBuffer > > indexBuffers_
 Index buffers.
 
Vector< Vector< SharedPtr
< Geometry > > > 
geometries_
 Geometries.
 
Vector< PODVector< unsigned > > geometryBoneMappings_
 Geometry bone mappings.
 
PODVector< Vector3geometryCenters_
 Geometry centers.
 
Vector< ModelMorphmorphs_
 Vertex morphs.
 
PODVector< unsigned > morphRangeStarts_
 Vertex buffer morph range start.
 
PODVector< unsigned > morphRangeCounts_
 Vertex buffer morph range vertex count.
 
Vector< VertexBufferDescloadVBData_
 Vertex buffer data for asynchronous loading.
 
Vector< IndexBufferDescloadIBData_
 Index buffer data for asynchronous loading.
 
Vector< PODVector< GeometryDesc > > loadGeometries_
 Geometry definitions for asynchronous loading.
 

Additional Inherited Members

- Protected Attributes inherited from Urho3D::Object
Contextcontext_
 Execution context.
 

Detailed Description

3D model resource.


The documentation for this class was generated from the following files:
  • Source/Urho3D/Graphics/Model.h
  • Source/Urho3D/Graphics/Model.cpp