Rebel Fork Framework
Urho3D::Drawable Class Referenceabstract

Base class for visible components. More...

#include <Urho3D/Graphics/Drawable.h>

Inheritance diagram for Urho3D::Drawable:
Urho3D::Component Urho3D::PipelineStateTracker Urho3D::Serializable Urho3D::Object Urho3D::RefCounted Urho3D::BillboardSet Urho3D::CustomGeometry Urho3D::DecalSet Urho3D::Drawable2D Urho3D::Light Urho3D::Renderer2D Urho3D::RibbonTrail Urho3D::StaticModel Urho3D::StaticModelForLightmap Urho3D::TerrainPatch Urho3D::Text3D Urho3D::Zone

Public Member Functions

 Drawable (Context *context, DrawableFlags drawableFlags=DRAWABLE_UNDEFINED)
 ~Drawable () override
void OnSetEnabled () override
 Handle enabled/disabled state change.
void ProcessCustomRayQuery (const RayOctreeQuery &query, const BoundingBox &worldBoundingBox, ea::vector< RayQueryResult > &results)
 Process raycast with custom transform.
virtual void ProcessRayQuery (const RayOctreeQuery &query, ea::vector< RayQueryResult > &results)
 Process octree raycast. May be called from a worker thread.
virtual void Update (const FrameInfo &frame)
 Update before octree reinsertion. Is called from a worker thread.
virtual void UpdateBatches (const FrameInfo &frame)
 Calculate distance and prepare batches for rendering. May be called from worker thread(s), possibly re-entrantly.
virtual void UpdateBatchesDelayed (const FrameInfo &frame)
 Batch update from main thread. Called on demand only if RequestUpdateBatchesDelayed() is called from UpdateBatches().
virtual void UpdateGeometry (const FrameInfo &frame)
 Prepare geometry for rendering.
virtual UpdateGeometryType GetUpdateGeometryType ()
 Return whether a geometry update is necessary, and if it can happen in a worker thread.
virtual GeometryGetLodGeometry (unsigned batchIndex, unsigned level)
 Return the geometry for a specific LOD level.
virtual unsigned GetNumOccluderTriangles ()
 Return number of occlusion geometry triangles.
virtual bool DrawOcclusion (OcclusionBuffer *buffer)
 Draw to occlusion buffer. Return true if did not run out of triangles.
void DrawDebugGeometry (DebugRenderer *debug, bool depthTest) override
 Visualize the component as debug geometry.
void SetDrawDistance (float distance)
void SetShadowDistance (float distance)
void SetLodBias (float bias)
void SetViewMask (unsigned mask)
void SetLightMask (unsigned mask)
void SetShadowMask (unsigned mask)
void SetZoneMask (unsigned mask)
void SetCastShadows (bool enable)
void SetOccluder (bool enable)
void SetOccludee (bool enable)
void SetGlobalIlluminationType (GlobalIlluminationType type)
 Set GI type.
void SetReflectionMode (ReflectionMode mode)
 Set reflection mode.
void MarkForUpdate ()
 Mark for update and octree reinsertion. Update is automatically queued when the drawable's scene node moves or changes scale.
const BoundingBoxGetBoundingBox () const
const BoundingBoxGetWorldBoundingBox ()
DrawableFlags GetDrawableFlags () const
 Return drawable flags.
float GetDrawDistance () const
float GetShadowDistance () const
float GetLodBias () const
unsigned GetViewMask () const
unsigned GetLightMask () const
unsigned GetShadowMask () const
unsigned GetZoneMask () const
bool GetCastShadows () const
bool IsOccluder () const
bool IsOccludee () const
GlobalIlluminationType GetGlobalIlluminationType () const
 Return global illumination type.
ReflectionMode GetReflectionMode () const
 Return reflection mode.
bool IsInView () const
bool IsInView (Camera *camera) const
 Return whether is in view of a specific camera this frame. Pass in a null camera to allow any camera, including shadow map cameras.
const ea::vector< SourceBatch > & GetBatches () const
 Return draw call source data.
void SetZone (Zone *zone, bool temporary=false)
 Set new zone. Zone assignment may optionally be temporary, meaning it needs to be re-evaluated on the next frame.
void SetSortValue (float value)
 Set sorting value.
void MarkInView (const FrameInfo &frame)
 Mark in view. Also clear the light list.
void MarkInView (unsigned frameNumber)
 Mark in view without specifying a camera. Used for shadow casters.
OctantGetOctant () const
 Return octree octant.
unsigned GetDrawableIndex () const
 Return index in octree.
bool IsInOctree () const
 Return whether the drawable is added to Octree.
ZoneGetZone () const
bool IsZoneDirty () const
 Return whether current zone is inconclusive or dirty due to the drawable moving.
float GetDistance () const
 Return distance from camera.
float GetLodDistance () const
 Return LOD scaled distance from camera.
float GetSortValue () const
 Return sorting value.
bool IsInView (const FrameInfo &frame, bool anyCamera=false) const
 Return whether is in view on the current frame. Called by View.
unsigned & GetMutableLightProbeTetrahedronHint ()
 Return mutable light probe tetrahedron hint.
CachedDrawableZoneGetMutableCachedZone ()
 Return mutable cached zone data.
CachedDrawableReflectionGetMutableCachedReflection ()
 Return mutable cached reflection data.
unsigned GetLightMaskInZone () const
 Return combined light masks of Drawable and its currently cached Zone.
unsigned GetShadowMaskInZone () const
 Return combined shadow masks of Drawable and its currently cached Zone.
- Public Member Functions inherited from Urho3D::Component
 Component (Context *context)
 ~Component () override
AttributeScopeHint GetEffectiveScopeHint () const
bool Save (Serializer &dest) const override
 Save as binary data. Return true if successful.
bool SaveXML (XMLElement &dest) const override
 Save as XML data. Return true if successful.
bool SaveJSON (JSONValue &dest) const override
 Save as JSON data. Return true if successful.
virtual void GetDependencyNodes (ea::vector< Node * > &dest)
 Return the depended on nodes to order network updates.
virtual bool HasAuxiliaryData () const
virtual void SerializeAuxiliaryData (Archive &archive)
 Serialize auxiliary data from/to the current block of the archive. May throw ArchiveException.
void SetEnabled (bool enable)
void Remove ()
 Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.
unsigned GetID () const
Node * GetNode () const
SceneGetScene () const
 Return the scene the node belongs to.
bool IsEnabled () const
bool IsEnabledEffective () const
ea::string GetFullNameDebug () const
 Return full component name for debugging. Unique for each component in the scene. Slow!
ComponentGetComponent (StringHash type) const
 Return component in the same scene node by type. If there are several, returns the first.
template<class T >
T * GetComponent () const
 Template version of returning a component in the same scene node by type.
unsigned GetIndexInParent () const
 Return index of this component in the node.
- Public Member Functions inherited from Urho3D::Serializable
 Serializable (Context *context)
 ~Serializable () override
virtual void OnSetAttribute (const AttributeInfo &attr, const Variant &src)
 Handle attribute write access. Default implementation writes to the variable at offset, or invokes the set accessor.
virtual void OnGetAttribute (const AttributeInfo &attr, Variant &dest) const
 Handle attribute read access. Default implementation reads the variable at offset, or invokes the get accessor.
virtual ObjectReflectionGetReflection () const
 Return reflection used for serialization.
virtual const ea::vector< AttributeInfo > * GetAttributes () const
 Return attribute descriptions, or null if none defined.
void SerializeInBlock (Archive &archive) override
 Serialize content from/to archive. May throw ArchiveException.
void SerializeInBlock (Archive &archive, bool serializeTemporary)
virtual bool Load (Deserializer &source)
 Load from binary data. Return true if successful.
virtual bool LoadXML (const XMLElement &source)
 Load from XML data. Return true if successful.
virtual bool LoadJSON (const JSONValue &source)
 Load from JSON data. Return true if successful.
virtual bool Load (const ea::string &resourceName)
 Load from binary resource.
virtual bool LoadXML (const ea::string &resourceName)
 Load from XML resource.
virtual bool LoadJSON (const ea::string &resourceName)
 Load from JSON resource.
virtual bool LoadFile (const ea::string &resourceName)
 Load from resource of automatically detected type.
virtual void ApplyAttributes ()
 Apply attribute changes that can not be applied immediately. Called after scene load or a network update.
virtual bool SaveDefaultAttributes (const AttributeInfo &attr) const
 Return whether should save default-valued attributes into XML. Default false.
bool SetAttribute (unsigned index, const Variant &value)
bool SetAttribute (const ea::string &name, const Variant &value)
 Set attribute by name. Return true if successfully set.
void SetInstanceDefault (bool enable)
 (Internal use) Set instance-level default flag.
void SetInstanceDefault (const ea::string &name, const Variant &defaultValue)
 (Internal use) Set instance-level default value. Allocate the internal data structure as necessary.
virtual Variant GetInstanceDefault (const ea::string &name) const
 (Internal use) Get instance-level default value.
void ResetToDefault ()
 Reset all editable attributes to their default values.
void RemoveInstanceDefault ()
 Remove instance's default values if they are set previously.
void SetTemporary (bool enable)
Variant GetAttribute (unsigned index) const
Variant GetAttribute (const ea::string &name) const
 Return attribute value by name. Return empty if not found.
Variant GetAttributeDefault (unsigned index) const
Variant GetAttributeDefault (const ea::string &name) const
 Return attribute default value by name. Return empty if not found.
unsigned GetNumAttributes () const
void CopyAttributes (const Serializable *source, bool resetToDefault=true)
 Copy all attributes from another serializable.
SharedPtr< SerializableClone (bool resetToDefault=true) const
 Clone this serializable.
bool IsTemporary () const
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 ~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.
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 ()
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.

Static Public Member Functions

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

Protected Member Functions

unsigned RecalculatePipelineStateHash () const override
 Recalculate hash. Shall be save to call from multiple threads as long as the object is not changing.
void OnNodeSet (Node *previousNode, Node *currentNode) override
 Handle node being assigned.
void OnSceneSet (Scene *scene) override
 Handle scene being assigned.
void OnMarkedDirty (Node *node) override
 Handle node transform being dirtied.
virtual void OnWorldBoundingBoxUpdate ()=0
 Recalculate the world-space bounding box.
virtual void OnRemoveFromOctree ()
 Handle removal from octree.
void AddToOctree ()
 Add to octree.
void RemoveFromOctree ()
 Remove from octree.
void RequestUpdateBatchesDelayed (const FrameInfo &frame)
 Request UpdateBatchesDelayed call from main thread.
void SetOctant (Octant *octant)
 Move into another octree octant.
void SetDrawableIndex (unsigned drawableIndex)
 Update drawable index.
- Protected Member Functions inherited from Urho3D::Component
virtual void OnNodeSetEnabled (Node *node)
 Handle scene node enabled status changing.
void SetID (unsigned id)
void SetNode (Node *node)
 Set scene node. Called by Node when creating the component.
ComponentGetFixedUpdateSource ()
 Return a component from the scene root that sends out fixed update events (either PhysicsWorld or PhysicsWorld2D). Return null if neither exists.
void DoAutoRemove (AutoRemoveMode mode)
 Perform autoremove. Called by subclasses. Caller should keep a weak pointer to itself to check whether was actually removed, and return immediately without further member operations in that case.
- 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.

Static Protected Member Functions

static GeometryGetGeometryIfNotEmpty (Geometry *geometry)
 Get Geometry pointer if the source one is not null or empty.

Protected Attributes

BoundingBox worldBoundingBox_
 World-space bounding box.
BoundingBox boundingBox_
 Local-space bounding box.
ea::vector< SourceBatchbatches_
 Draw call source data.
DrawableFlags drawableFlags_
 Drawable flags.
GlobalIlluminationType giType_ {}
 Global illumination type.
ReflectionMode reflectionMode_ {ReflectionMode::BlendProbesAndZone}
 Reflection mode.
bool worldBoundingBoxDirty_
 Bounding box dirty flag.
bool castShadows_
 Shadowcaster flag.
bool occluder_
 Occluder flag.
bool occludee_
 Occludee flag.
bool updateQueued_
 Octree update queued flag.
bool zoneDirty_
 Zone inconclusive or dirtied flag.
 Octree octant.
unsigned drawableIndex_ { M_MAX_UNSIGNED }
 Index of Drawable in Scene. May be updated.
CachedDrawableZone cachedZone_
 Current zone.
CachedDrawableReflection cachedReflection_
 Current reflection.
unsigned viewMask_
 View mask.
unsigned lightMask_
 Light mask.
unsigned shadowMask_
 Shadow mask.
unsigned zoneMask_
 Zone mask.
unsigned viewFrameNumber_
 Last visible frame number.
float distance_
 Current distance to camera.
float lodDistance_
 LOD scaled distance.
float drawDistance_
 Draw distance.
float shadowDistance_
 Shadow distance.
float sortValue_
 Current sort value.
float lodBias_
 LOD bias.
unsigned lightProbeTetrahedronHint_ { M_MAX_UNSIGNED }
 Light probe tetrahedron hint.
ea::vector< Camera * > viewCameras_
 List of cameras from which is seen on the current frame.
- Protected Attributes inherited from Urho3D::Component
Node * node_
 Scene node.
unsigned id_
 Unique ID within the scene.
bool networkUpdate_
 Network update queued flag.
bool enabled_
 Enabled flag.
- Protected Attributes inherited from Urho3D::Serializable
ea::unique_ptr< VariantMapinstanceDefaultValues_
 Attribute default value at each instance level.
bool setInstanceDefault_
 When true, store the attribute value as instance's default value (internal use only).
bool temporary_
 Temporary flag.
- Protected Attributes inherited from Urho3D::Object
WeakPtr< Contextcontext_
 Execution context.

Private Member Functions

 URHO3D_OBJECT (Drawable, Component)


class Octant
class Octree

Additional Inherited Members

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

Detailed Description

Base class for visible components.

Member Function Documentation

◆ GetBoundingBox()

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

Return local space bounding box. May not be applicable or properly updated on all drawables.

◆ GetCastShadows()

bool Urho3D::Drawable::GetCastShadows ( ) const

Return shadowcaster flag.

◆ GetDrawDistance()

float Urho3D::Drawable::GetDrawDistance ( ) const

Return draw distance.

◆ GetLightMask()

unsigned Urho3D::Drawable::GetLightMask ( ) const

Return light mask.

◆ GetLodBias()

float Urho3D::Drawable::GetLodBias ( ) const

Return LOD bias.

◆ GetShadowDistance()

float Urho3D::Drawable::GetShadowDistance ( ) const

Return shadow draw distance.

◆ GetShadowMask()

unsigned Urho3D::Drawable::GetShadowMask ( ) const

Return shadow mask.

◆ GetViewMask()

unsigned Urho3D::Drawable::GetViewMask ( ) const

Return view mask.

◆ GetWorldBoundingBox()

const BoundingBox & Urho3D::Drawable::GetWorldBoundingBox ( )

Return world-space bounding box.

◆ GetZone()

Zone* Urho3D::Drawable::GetZone ( ) const

Return current zone.

◆ GetZoneMask()

unsigned Urho3D::Drawable::GetZoneMask ( ) const

Return zone mask.

◆ IsInView()

bool Urho3D::Drawable::IsInView ( ) const

Return whether is in view this frame from any viewport camera. Excludes shadow map cameras.

◆ IsOccludee()

bool Urho3D::Drawable::IsOccludee ( ) const

Return occludee flag.

◆ IsOccluder()

bool Urho3D::Drawable::IsOccluder ( ) const

Return occluder flag.

◆ RegisterObject()

void Urho3D::Drawable::RegisterObject ( Context context)

Register object attributes. Drawable must be registered first.

◆ SetCastShadows()

void Urho3D::Drawable::SetCastShadows ( bool  enable)

Set shadowcaster flag.

◆ SetDrawDistance()

void Urho3D::Drawable::SetDrawDistance ( float  distance)

Set draw distance.

◆ SetLightMask()

void Urho3D::Drawable::SetLightMask ( unsigned  mask)

Set light mask. Is and'ed with light's and zone's light mask to see if the object should be lit.

◆ SetLodBias()

void Urho3D::Drawable::SetLodBias ( float  bias)

Set LOD bias.

◆ SetOccludee()

void Urho3D::Drawable::SetOccludee ( bool  enable)

Set occludee flag.

◆ SetOccluder()

void Urho3D::Drawable::SetOccluder ( bool  enable)

Set occlusion flag.

◆ SetShadowDistance()

void Urho3D::Drawable::SetShadowDistance ( float  distance)

Set shadow draw distance.

◆ SetShadowMask()

void Urho3D::Drawable::SetShadowMask ( unsigned  mask)

Set shadow mask. Is and'ed with light's light mask and zone's shadow mask to see if the object should be rendered to a shadow map.

◆ SetViewMask()

void Urho3D::Drawable::SetViewMask ( unsigned  mask)

Set view mask. Is and'ed with camera's view mask to see if the object should be rendered.

◆ SetZoneMask()

void Urho3D::Drawable::SetZoneMask ( unsigned  mask)

Set zone mask. Is and'ed with zone's zone mask to see if the object should belong to the zone.

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