Reflection probe manager. More...

#include <Urho3D/Graphics/ReflectionProbe.h>

Inheritance diagram for Urho3D::ReflectionProbeManager:

Classes
struct	AutoQueueCache

struct	QueuedReflectionProbe

struct	SpatialCache

Public Types
using	ReflectionProbeSpan = TransformedSpan< TrackedComponentBase const, ReflectionProbe const, StaticCaster< ReflectionProbe *const > >

Public Member Functions
	ReflectionProbeManager (Context *context)

void	DrawDebugGeometry (DebugRenderer *debug, bool depthTest) override
	Visualize the component as debug geometry.

void	MarkProbeDirty (ReflectionProbe *reflectionProbe)
	Mark reflection probe as dirty, i.e. position or dimensions changed.

void	MarkProbeTransformDirty (ReflectionProbe *reflectionProbe)

void	MarkProbeRealtimeDirty (ReflectionProbe *reflectionProbe)

void	QueueProbeUpdate (ReflectionProbe *reflectionProbe)
	Queue reflection probe rendering as soon as possible.

void	QueueBakeAll ()
	Queue rendering of all Baked reflection probes.

void	Update ()
	Update reflection probes if dirty. Usually called internally once per frame.

void	QueryDynamicProbes (const BoundingBox &worldBoundingBox, ea::span< ReflectionProbeReference, 2 > probes) const
	Query two most important reflection probes.

void	QueryStaticProbes (const BoundingBox &worldBoundingBox, ea::span< ReflectionProbeReference, 2 > probes, float &cacheDistanceSquared) const

ReflectionProbeSpan	GetReflectionProbes () const
	Return all reflection probes.

unsigned	GetRevision () const

bool	HasStaticProbes () const

bool	HasDynamicProbes () const

Public Member Functions inherited from Urho3D::TrackedComponentRegistryBase
	TrackedComponentRegistryBase (Context *context, StringHash componentType)

TrackedComponentBase *	GetTrackedComponentByIndex (unsigned index) const

unsigned	GetNumTrackedComponents () const

ea::span< TrackedComponentBase *const >	GetTrackedComponents () const

void	AddTrackedComponent (TrackedComponentBase *component)

void	RemoveTrackedComponent (TrackedComponentBase *component)

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

	~Component () override
	Destruct.

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

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

Scene *	GetScene () 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!

Component *	GetComponent (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)
	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 ObjectReflection *	GetReflection () 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< Serializable >	Clone (bool resetToDefault=true) const
	Clone this serializable.

bool	IsTemporary () const

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.

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::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Static Public Attributes
static constexpr bool	IsOnlyEnabledTracked = true

static constexpr float	DefaultQueryPadding = 2.0f

static constexpr unsigned	DefaultRenderBudget = 6

Static Public Attributes inherited from Urho3D::TrackedComponentRegistryBase
static constexpr bool	IsOnlyEnabledTracked = false

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

Protected Member Functions
void	OnSceneSet (Scene previousScene, Scene scene) override
	Handle scene being assigned. This may happen several times during the component's lifetime. Scene-wide subsystems and events are subscribed to here.

void	OnComponentAdded (TrackedComponentBase *baseComponent) override

void	OnComponentRemoved (TrackedComponentBase *baseComponent) override

Protected Member Functions inherited from Urho3D::TrackedComponentRegistryBase
void	OnSceneSet (Scene previousScene, Scene scene) override
	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	OnComponentMoved (TrackedComponentBase *baseComponent, unsigned oldIndex)

virtual void	OnAddedToScene (Scene *scene)

virtual void	OnRemovedFromScene ()

Protected Member Functions inherited from Urho3D::Component
virtual void	OnNodeSet (Node previousNode, Node currentNode)
	Handle scene node being assigned at creation.

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.

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.

Private Member Functions
	URHO3D_OBJECT (ReflectionProbeManager, TrackedComponentRegistryBase)

void	UpdateSpatialCache ()

void	UpdateAutoQueueCache ()

void	FillUpdateQueue ()

void	ConsumeUpdateQueue ()

void	RestoreCubemaps ()

ea::string	GetBakedProbeFilePath () const

ea::string	SaveTextureToFile (TextureCube *texture, const ea::string &filePath, const ea::string &fileName)

Private Attributes
struct Urho3D::ReflectionProbeManager::SpatialCache	spatial_

struct Urho3D::ReflectionProbeManager::AutoQueueCache	autoQueue_

SharedPtr< CubemapRenderer >	cubemapRenderer_

float	queryPadding_ {DefaultQueryPadding}

unsigned	renderBudget_ {DefaultRenderBudget}

bool	filterCubemaps_ {true}

ea::unordered_set< WeakPtr< ReflectionProbe > >	probesToUpdate_

ea::vector< QueuedReflectionProbe >	updateQueue_

ea::vector< QueuedReflectionProbe >	frameUpdates_

Static Private Attributes
static constexpr unsigned	MaxStaticUpdates = 1

Additional Inherited Members
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< VariantMap >	instanceDefaultValues_
	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< Context >	context_
	Execution context.

Detailed Description

Reflection probe manager.

Member Function Documentation

◆ DrawDebugGeometry()

void Urho3D::ReflectionProbeManager::DrawDebugGeometry	(	DebugRenderer *	debug,
		bool	depthTest
	)

overridevirtual

Visualize the component as debug geometry.

Reimplemented from Urho3D::Component.

◆ OnComponentAdded()

void Urho3D::ReflectionProbeManager::OnComponentAdded ( TrackedComponentBase * baseComponent )

overrideprotectedvirtual

Reimplemented from Urho3D::TrackedComponentRegistryBase.

◆ OnComponentRemoved()

void Urho3D::ReflectionProbeManager::OnComponentRemoved ( TrackedComponentBase * baseComponent )

overrideprotectedvirtual

Reimplemented from Urho3D::TrackedComponentRegistryBase.

◆ OnSceneSet()

void Urho3D::ReflectionProbeManager::OnSceneSet	(	Scene *	previousScene,
		Scene *	scene
	)

overrideprotectedvirtual

Handle scene being assigned. This may happen several times during the component's lifetime. Scene-wide subsystems and events are subscribed to here.

Reimplemented from Urho3D::Component.

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

Urho3D/Graphics/ReflectionProbe.h
Urho3D/Graphics/ReflectionProbe.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DrawDebugGeometry()

◆ OnComponentAdded()

◆ OnComponentRemoved()

◆ OnSceneSet()