Dviglo::DebugRenderer Class Reference

Debug geometry rendering component. Should be added only to the root scene node. More...

#include </home/runner/work/Dviglo/Dviglo/DvigloRepository/Source/Urho3D/Graphics/DebugRenderer.h>

Inheritance diagram for Dviglo::DebugRenderer:

Public Member Functions
	DebugRenderer (Context *context)
	Construct.
	~DebugRenderer () override
	Destruct.
void	SetLineAntiAlias (bool enable)
void	SetView (Camera *camera)
	Set the camera viewpoint. Call before rendering, or before adding geometry if you want to use culling.
void	AddLine (const Vector3 &start, const Vector3 &end, const Color &color, bool depthTest=true)
	Add a line.
void	AddLine (const Vector3 &start, const Vector3 &end, unsigned color, bool depthTest=true)
	Add a line with color already converted to unsigned.
void	AddTriangle (const Vector3 &v1, const Vector3 &v2, const Vector3 &v3, const Color &color, bool depthTest=true)
	Add a solid triangle.
void	AddTriangle (const Vector3 &v1, const Vector3 &v2, const Vector3 &v3, unsigned color, bool depthTest=true)
	Add a solid triangle with color already converted to unsigned.
void	AddPolygon (const Vector3 &v1, const Vector3 &v2, const Vector3 &v3, const Vector3 &v4, const Color &color, bool depthTest=true)
	Add a solid quadrangular polygon.
void	AddPolygon (const Vector3 &v1, const Vector3 &v2, const Vector3 &v3, const Vector3 &v4, unsigned color, bool depthTest=true)
	Add a solid quadrangular polygon with color already converted to unsigned.
void	AddNode (Node *node, float scale=1.0f, bool depthTest=true)
	Add a scene node represented as its coordinate axes.
void	AddBoundingBox (const BoundingBox &box, const Color &color, bool depthTest=true, bool solid=false)
	Add a bounding box.
void	AddBoundingBox (const BoundingBox &box, const Matrix3x4 &transform, const Color &color, bool depthTest=true, bool solid=false)
	Add a bounding box with transform.
void	AddFrustum (const Frustum &frustum, const Color &color, bool depthTest=true)
	Add a frustum.
void	AddPolyhedron (const Polyhedron &poly, const Color &color, bool depthTest=true)
	Add a polyhedron.
void	AddSphere (const Sphere &sphere, const Color &color, bool depthTest=true)
	Add a sphere.
void	AddSphereSector (const Sphere &sphere, const Quaternion &rotation, float angle, bool drawLines, const Color &color, bool depthTest=true)
	Add a sphere sector. Angle ranges from 0 to 360. Identity Quaternion yields the filled portion of the sector upwards.
void	AddCylinder (const Vector3 &position, float radius, float height, const Color &color, bool depthTest=true)
	Add a cylinder.
void	AddSkeleton (const Skeleton &skeleton, const Color &color, bool depthTest=true)
	Add a skeleton.
void	AddTriangleMesh (const void *vertexData, unsigned vertexSize, const void *indexData, unsigned indexSize, unsigned indexStart, unsigned indexCount, const Matrix3x4 &transform, const Color &color, bool depthTest=true)
	Add a triangle mesh.
void	AddTriangleMesh (const void *vertexData, unsigned vertexSize, unsigned vertexStart, const void *indexData, unsigned indexSize, unsigned indexStart, unsigned indexCount, const Matrix3x4 &transform, const Color &color, bool depthTest=true)
	Add a triangle mesh.
void	AddCircle (const Vector3 &center, const Vector3 &normal, float radius, const Color &color, int steps=64, bool depthTest=true)
	Add a circle.
void	AddCross (const Vector3 &center, float size, const Color &color, bool depthTest=true)
	Add a cross.
void	AddQuad (const Vector3 &center, float width, float height, const Color &color, bool depthTest=true)
	Add a quad on the XZ plane.
void	Render ()
	Update vertex buffer and render all debug lines. The viewport and rendertarget should be set before.
bool	GetLineAntiAlias () const
const Matrix3x4 &	GetView () const
	Return the view transform.
const Matrix4 &	GetProjection () const
	Return the projection transform.
const Frustum &	GetFrustum () const
	Return the view frustum.
bool	IsInside (const BoundingBox &box) const
	Check whether a bounding box is inside the view frustum.
bool	HasContent () const
	Return whether has something to render.
Public Member Functions inherited from Dviglo::Component
	Component (Context *context)
	Construct.
	~Component () override
	Destruct.
virtual void	OnSetEnabled ()
	Handle enabled/disabled state change.
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.
virtual void	DrawDebugGeometry (DebugRenderer *debug, bool depthTest)
	Visualize the component as debug geometry.
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::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 (DebugRenderer, Component)
void	HandleEndFrame (StringHash eventType, VariantMap &eventData)
	Handle end of frame. Clear debug geometry.

Private Attributes
PODVector< DebugLine >	lines_
	Lines rendered with depth test.
PODVector< DebugLine >	noDepthLines_
	Lines rendered without depth test.
PODVector< DebugTriangle >	triangles_
	Triangles rendered with depth test.
PODVector< DebugTriangle >	noDepthTriangles_
	Triangles rendered without depth test.
Matrix3x4	view_
	View transform.
Matrix4	projection_
	Projection transform.
Matrix4	gpuProjection_
	Projection transform in API-specific format.
Frustum	frustum_
	View frustum.
SharedPtr< VertexBuffer >	vertexBuffer_
	Vertex buffer.
bool	lineAntiAlias_
	Line antialiasing flag.

Additional Inherited Members
Protected Member Functions inherited from Dviglo::Component
void	OnAttributeAnimationAdded () override
	Handle attribute animation added.
void	OnAttributeAnimationRemoved () override
	Handle attribute animation removed.
virtual void	OnNodeSet (Node *node)
	Handle scene node being assigned at creation.
virtual void	OnSceneSet (Scene *scene)
	Handle scene being assigned. This may happen several times during the component's lifetime. Scene-wide subsystems and events are subscribed to here.
virtual void	OnMarkedDirty (Node *node)
	Handle scene node transform dirtied.
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::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

Debug geometry rendering component. Should be added only to the root scene node.

Member Function Documentation

GetLineAntiAlias()

bool Dviglo::DebugRenderer::GetLineAntiAlias ( ) const

inline

Return whether line antialiasing is enabled.

RegisterObject()

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

static

Register object factory.

SetLineAntiAlias()

void Dviglo::DebugRenderer::SetLineAntiAlias

(

bool

enable

)

Set line antialiasing on/off. Default false.

---

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

• /home/runner/work/Dviglo/Dviglo/DvigloRepository/Source/Urho3D/Graphics/DebugRenderer.h
• /home/runner/work/Dviglo/Dviglo/DvigloRepository/Source/Urho3D/Graphics/DebugRenderer.cpp