2D renderer component. More...

#include </home/runner/work/Dviglo/Dviglo/DvigloRepository/Source/Urho3D/Urho2D/Renderer2D.h>

Inheritance diagram for Dviglo::Renderer2D:

Public Member Functions
	Renderer2D (Context *context)
	Construct.

	~Renderer2D () override
	Destruct.

void	ProcessRayQuery (const RayOctreeQuery &query, PODVector< RayQueryResult > &results) override
	Process octree raycast. May be called from a worker thread.

void	UpdateBatches (const FrameInfo &frame) override
	Calculate distance and prepare batches for rendering. May be called from worker thread(s), possibly re-entrantly.

void	UpdateGeometry (const FrameInfo &frame) override
	Prepare geometry for rendering. Called from a worker thread if possible (no GPU update).

UpdateGeometryType	GetUpdateGeometryType () override
	Return whether a geometry update is necessary, and if it can happen in a worker thread.

void	AddDrawable (Drawable2D *drawable)
	Add Drawable2D.

void	RemoveDrawable (Drawable2D *drawable)
	Remove Drawable2D.

Material *	GetMaterial (Texture2D *texture, BlendMode blendMode)
	Return material by texture and blend mode.

bool	CheckVisibility (Drawable2D *drawable) const
	Check visibility.

Public Member Functions inherited from Dviglo::Drawable
	Drawable (Context *context, unsigned char drawableFlags)
	Construct.

	~Drawable () override
	Destruct.

void	OnSetEnabled () override
	Handle enabled/disabled state change.

virtual void	Update (const FrameInfo &frame)
	Update before octree reinsertion. Is called from a worker thread.

virtual Geometry *	GetLodGeometry (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	SetMaxLights (unsigned num)

void	SetCastShadows (bool enable)

void	SetOccluder (bool enable)

void	SetOccludee (bool enable)

void	MarkForUpdate ()
	Mark for update and octree reinsertion. Update is automatically queued when the drawable's scene node moves or changes scale.

const BoundingBox &	GetBoundingBox () const

const BoundingBox &	GetWorldBoundingBox ()

unsigned char	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

unsigned	GetMaxLights () const

bool	GetCastShadows () const

bool	IsOccluder () const

bool	IsOccludee () const

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 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	SetMinMaxZ (float minZ, float maxZ)
	Set view-space depth bounds.

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.

void	LimitLights ()
	Sort and limit per-pixel lights to maximum allowed. Convert extra lights into vertex lights.

void	LimitVertexLights (bool removeConvertedLights)
	Sort and limit per-vertex lights to maximum allowed.

void	SetBasePass (unsigned batchIndex)
	Set base pass flag for a batch.

Octant *	GetOctant () const
	Return octree octant.

Zone *	GetZone () 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.

bool	HasBasePass (unsigned batchIndex) const
	Return whether has a base pass.

const PODVector< Light * > &	GetLights () const
	Return per-pixel lights.

const PODVector< Light * > &	GetVertexLights () const
	Return per-vertex lights.

Light *	GetFirstLight () const
	Return the first added per-pixel light.

float	GetMinZ () const
	Return the minimum view-space depth.

float	GetMaxZ () const
	Return the maximum view-space depth.

void	AddLight (Light *light)
	Add a per-pixel light affecting the object this frame.

void	AddVertexLight (Light *light)
	Add a per-vertex light affecting the object this frame.

Public Member Functions inherited from Dviglo::Component
	Component (Context *context)
	Construct.

	~Component () override
	Destruct.

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.

void	MarkNetworkUpdate () override
	Mark for attribute check on the next network update.

virtual void	GetDependencyNodes (PODVector< Node * > &dest)
	Return the depended on nodes to order network updates.

void	SetEnabled (bool enable)

void	Remove ()
	Remove from the scene node. If no other shared pointer references exist, causes immediate deletion.

unsigned	GetID () const

bool	IsReplicated () const

Node *	GetNode () const

Scene *	GetScene () const
	Return the scene the node belongs to.

bool	IsEnabled () const

bool	IsEnabledEffective () const

Component *	GetComponent (StringHash type) const
	Return component in the same scene node by type. If there are several, returns the first.

void	GetComponents (PODVector< Component * > &dest, StringHash type) const
	Return components in the same scene node by type.

template<class T >
T *	GetComponent () const
	Template version of returning a component in the same scene node by type.

template<class T >
void	GetComponents (PODVector< T * > &dest) const
	Template version of returning components in the same scene node by type.

void	AddReplicationState (ComponentReplicationState *state)
	Add a replication state that is tracking this component.

void	PrepareNetworkUpdate ()
	Prepare network update by comparing attributes and marking replication states dirty as necessary.

void	CleanupConnection (Connection *connection)

Public Member Functions inherited from Dviglo::Animatable
	Animatable (Context *context)
	Construct.

	~Animatable () override
	Destruct.

bool	LoadXML (const XMLElement &source) override
	Load from XML data. Return true if successful.

bool	LoadJSON (const JSONValue &source) override
	Load from JSON data. Return true if successful.

void	SetAnimationEnabled (bool enable)

void	SetAnimationTime (float time)
	Set time position of all attribute animations or an object animation manually. Automatic update should be disabled in this case.

void	SetObjectAnimation (ObjectAnimation *objectAnimation)

void	SetAttributeAnimation (const String &name, ValueAnimation *attributeAnimation, WrapMode wrapMode=WM_LOOP, float speed=1.0f)
	Set attribute animation.

void	SetAttributeAnimationWrapMode (const String &name, WrapMode wrapMode)
	Set attribute animation wrap mode.

void	SetAttributeAnimationSpeed (const String &name, float speed)
	Set attribute animation speed.

void	SetAttributeAnimationTime (const String &name, float time)
	Set attribute animation time position manually. Automatic update should be disabled in this case.

void	RemoveObjectAnimation ()
	Remove object animation. Same as calling SetObjectAnimation with a null pointer.

void	RemoveAttributeAnimation (const String &name)
	Remove attribute animation. Same as calling SetAttributeAnimation with a null pointer.

bool	GetAnimationEnabled () const

ObjectAnimation *	GetObjectAnimation () const

ValueAnimation *	GetAttributeAnimation (const String &name) const
	Return attribute animation.

WrapMode	GetAttributeAnimationWrapMode (const String &name) const
	Return attribute animation wrap mode.

float	GetAttributeAnimationSpeed (const String &name) const
	Return attribute animation speed.

float	GetAttributeAnimationTime (const String &name) const
	Return attribute animation time position.

void	SetObjectAnimationAttr (const ResourceRef &value)
	Set object animation attribute.

ResourceRef	GetObjectAnimationAttr () const
	Return object animation attribute.

Public Member Functions inherited from Dviglo::Serializable
	Serializable (Context *context)
	Construct.

	~Serializable () override
	Destruct.

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 const Vector< AttributeInfo > *	GetAttributes () const
	Return attribute descriptions, or null if none defined.

virtual const Vector< AttributeInfo > *	GetNetworkAttributes () const
	Return network replication attribute descriptions, or null if none defined.

virtual bool	Load (Deserializer &source)
	Load from binary data. Return true if successful.

virtual void	ApplyAttributes ()
	Apply attribute changes that can not be applied immediately. Called after scene load or a network update.

virtual bool	SaveDefaultAttributes () const
	Return whether should save default-valued attributes into XML. Default false.

bool	SetAttribute (unsigned index, const Variant &value)

bool	SetAttribute (const String &name, const Variant &value)
	Set attribute by name. Return true if successfully set.

void	SetInstanceDefault (bool enable)
	Set instance-level default flag.

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)

void	SetInterceptNetworkUpdate (const String &attributeName, bool enable)
	Enable interception of an attribute from network updates. Intercepted attributes are sent as events instead of applying directly. This can be used to implement client side prediction.

void	AllocateNetworkState ()
	Allocate network attribute state.

void	WriteInitialDeltaUpdate (Serializer &dest, unsigned char timeStamp)
	Write initial delta network update.

void	WriteDeltaUpdate (Serializer &dest, const DirtyBits &attributeBits, unsigned char timeStamp)
	Write a delta network update according to dirty attribute bits.

void	WriteLatestDataUpdate (Serializer &dest, unsigned char timeStamp)
	Write a latest data network update.

bool	ReadDeltaUpdate (Deserializer &source)
	Read and apply a network delta update. Return true if attributes were changed.

bool	ReadLatestDataUpdate (Deserializer &source)
	Read and apply a network latest data update. Return true if attributes were changed.

Variant	GetAttribute (unsigned index) const

Variant	GetAttribute (const String &name) const
	Return attribute value by name. Return empty if not found.

Variant	GetAttributeDefault (unsigned index) const

Variant	GetAttributeDefault (const String &name) const
	Return attribute default value by name. Return empty if not found.

unsigned	GetNumAttributes () const

unsigned	GetNumNetworkAttributes () const
	Return number of network replication attributes.

bool	IsTemporary () const

bool	GetInterceptNetworkUpdate (const String &attributeName) const
	Return whether an attribute's network updates are being intercepted.

NetworkState *	GetNetworkState () const
	Return the network attribute state, if allocated.

Public Member Functions inherited from Dviglo::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 Dviglo::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.

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

Static Public Member Functions inherited from Dviglo::Drawable
static void	RegisterObject (Context *context)

Static Public Member Functions inherited from Dviglo::Animatable
static void	RegisterObject (Context *context)

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

Private Member Functions
	URHO3D_OBJECT (Renderer2D, Drawable)

void	OnWorldBoundingBoxUpdate () override
	Recalculate the world-space bounding box.

SharedPtr< Material >	CreateMaterial (Texture2D *texture, BlendMode blendMode)
	Create material by texture and blend mode.

void	HandleBeginViewUpdate (StringHash eventType, VariantMap &eventData)
	Handle view update begin event. Determine Drawable2D's and their batches here.

void	GetDrawables (PODVector< Drawable2D * > &drawables, Node *node)
	Get all drawables in node.

void	UpdateViewBatchInfo (ViewBatchInfo2D &viewBatchInfo, Camera *camera)
	Update view batch info.

void	AddViewBatch (ViewBatchInfo2D &viewBatchInfo, Material *material, unsigned indexStart, unsigned indexCount, unsigned vertexStart, unsigned vertexCount, float distance)
	Add view batch.

Private Attributes
SharedPtr< IndexBuffer >	indexBuffer_
	Index buffer.

SharedPtr< Material >	material_
	Material.

PODVector< Drawable2D * >	drawables_
	Drawables.

FrameInfo	frame_
	View frame info for current frame.

HashMap< Camera *, ViewBatchInfo2D >	viewBatchInfos_
	View batch info.

Frustum	frustum_
	Frustum for current frame.

unsigned	viewMask_
	View mask of current camera for visibility checking.

HashMap< Texture2D *, HashMap< int, SharedPtr< Material > > >	cachedMaterials_
	Cached materials.

HashMap< int, SharedPtr< Technique > >	cachedTechniques_
	Cached techniques per blend mode.

Friends
void	CheckDrawableVisibilityWork (const WorkItem *item, unsigned threadIndex)

Additional Inherited Members
Protected Member Functions inherited from Dviglo::Drawable
void	OnNodeSet (Node *node) 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	OnRemoveFromOctree ()
	Handle removal from octree.

void	AddToOctree ()
	Add to octree.

void	RemoveFromOctree ()
	Remove from octree.

void	SetOctant (Octant *octant)
	Move into another octree octant.

Protected Member Functions inherited from Dviglo::Component
void	OnAttributeAnimationAdded () override
	Handle attribute animation added.

void	OnAttributeAnimationRemoved () override
	Handle attribute animation removed.

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.

void	HandleAttributeAnimationUpdate (StringHash eventType, VariantMap &eventData)
	Handle scene attribute animation update event.

Component *	GetFixedUpdateSource ()
	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 Dviglo::Animatable
virtual Animatable *	FindAttributeAnimationTarget (const String &name, String &outName)
	Find target of an attribute animation from object hierarchy by name.

void	SetObjectAttributeAnimation (const String &name, ValueAnimation *attributeAnimation, WrapMode wrapMode, float speed)
	Set object attribute animation internal.

void	OnObjectAnimationAdded (ObjectAnimation *objectAnimation)
	Handle object animation added.

void	OnObjectAnimationRemoved (ObjectAnimation *objectAnimation)
	Handle object animation removed.

void	UpdateAttributeAnimations (float timeStep)
	Update attribute animations.

bool	IsAnimatedNetworkAttribute (const AttributeInfo &attrInfo) const
	Is animated network attribute.

AttributeAnimationInfo *	GetAttributeAnimationInfo (const String &name) const
	Return attribute animation info.

void	HandleAttributeAnimationAdded (StringHash eventType, VariantMap &eventData)
	Handle attribute animation added.

void	HandleAttributeAnimationRemoved (StringHash eventType, VariantMap &eventData)
	Handle attribute animation removed.

Protected Attributes inherited from Dviglo::Drawable
BoundingBox	worldBoundingBox_
	World-space bounding box.

BoundingBox	boundingBox_
	Local-space bounding box.

Vector< SourceBatch >	batches_
	Draw call source data.

unsigned char	drawableFlags_
	Drawable flags.

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.

Octant *	octant_
	Octree octant.

Zone *	zone_
	Current zone.

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	minZ_
	Current minimum view space depth.

float	maxZ_
	Current maximum view space depth.

float	lodBias_
	LOD bias.

unsigned	basePassFlags_
	Base pass flags, bit per batch.

unsigned	maxLights_
	Maximum per-pixel lights.

PODVector< Camera * >	viewCameras_
	List of cameras from which is seen on the current frame.

Light *	firstLight_
	First per-pixel light added this frame.

PODVector< Light * >	lights_
	Per-pixel lights affecting this drawable.

PODVector< Light * >	vertexLights_
	Per-vertex lights affecting this drawable.

Protected Attributes inherited from Dviglo::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 Dviglo::Animatable
bool	animationEnabled_
	Animation enabled.

SharedPtr< ObjectAnimation >	objectAnimation_
	Animation.

HashSet< const AttributeInfo * >	animatedNetworkAttributes_
	Animated network attribute set.

HashMap< String, SharedPtr< AttributeAnimationInfo > >	attributeAnimationInfos_
	Attribute animation infos.

Protected Attributes inherited from Dviglo::Serializable
UniquePtr< NetworkState >	networkState_
	Network attribute state.

Protected Attributes inherited from Dviglo::Object
Context *	context_
	Execution context.

Detailed Description

2D renderer component.

Member Function Documentation

◆ RegisterObject()

void Dviglo::Renderer2D::RegisterObject ( Context * context )

static

Register object factory.

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

/home/runner/work/Dviglo/Dviglo/DvigloRepository/Source/Urho3D/Urho2D/Renderer2D.h
/home/runner/work/Dviglo/Dviglo/DvigloRepository/Source/Urho3D/Urho2D/Renderer2D.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ RegisterObject()