SystemUI widget used to edit materials. More...

#include <Urho3D/SystemUI/MaterialInspectorWidget.h>

Inheritance diagram for Urho3D::MaterialInspectorWidget:

Classes
struct	PropertyDesc

struct	TechniqueDesc

struct	TextureUnitDesc

Public Types
using	MaterialVector = ea::vector< SharedPtr< Material > >

Public Member Functions
	MaterialInspectorWidget (Context *context, const MaterialVector &materials)

void	UpdateTechniques (const ea::string &path)

void	RenderTitle ()

void	RenderContent ()

const MaterialVector &	GetMaterials () 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 void	OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
	Handle event.

virtual void	SerializeInBlock (Archive &archive)
	Serialize content from/to archive. May throw ArchiveException.

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	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.

Public Attributes
Signal< void()>	OnEditBegin

Signal< void()>	OnEditEnd

Private Types
using	TechniqueDescPtr = ea::shared_ptr< TechniqueDesc >

using	ShaderParameterNames = ea::fixed_set< ea::string, 128 >

Private Member Functions
	URHO3D_OBJECT (MaterialInspectorWidget, Object)

void	InitializePreviewScene ()

void	ApplyPreviewSettings ()

void	UpdateCachedTechniques ()

void	RenderPreview ()

void	RenderTechniques ()

void	RenderProperties ()

void	RenderTextures ()

void	RenderShaderParameters ()

bool	RenderTechniqueEntries ()

bool	EditTechniqueInEntry (TechniqueEntry &entry, float itemWidth)

bool	EditDistanceInEntry (TechniqueEntry &entry, float itemWidth)

bool	EditQualityInEntry (TechniqueEntry &entry)

void	RenderProperty (const PropertyDesc &desc)

void	RenderShaderDefines ()

void	RenderTextureUnit (const TextureUnitDesc &desc)

bool	IsDefaultTextureUnit (const ea::string &unit) const

ea::set< ea::string >	GetCustomTextureUnits () const

void	RenderCustomTextureUnit (const ea::string &unit)

void	RenderAddCustomTextureUnit (const ea::set< ea::string > &customTextureUnits)

ea::string	GetTechniqueDisplayName (const ea::string &resourceName) const

bool	IsTechniqueDeprecated (const ea::string &resourceName) const

ShaderParameterNames	GetShaderParameterNames () const

void	RenderShaderParameter (const ea::string &name)

void	RenderNewShaderParameter ()

Private Attributes
const ea::string	defaultTechniqueName_ {"Techniques/LitOpaque.xml"}

SharedPtr< Scene >	previewScene_

SharedPtr< SceneRendererToTexture >	previewWidget_

ea::unordered_map< ea::string, TechniqueDescPtr >	techniques_

ea::vector< TechniqueDescPtr >	sortedTechniques_

TechniqueDescPtr	defaultTechnique_

MaterialVector	materials_

ea::vector< TechniqueEntry >	techniqueEntries_

ea::vector< TechniqueEntry >	sortedTechniqueEntries_

bool	pendingSetTechniques_ {}

ea::vector< ea::pair< const PropertyDesc *, Variant > >	pendingSetProperties_

ea::vector< ea::pair< ea::string, Texture * > >	pendingSetTextures_

ShaderParameterNames	shaderParameterNames_

ea::vector< ea::pair< ea::string, Variant > >	pendingSetShaderParameters_

ea::string	newParameterName_

unsigned	newParameterType_ {}

ea::optional< bool >	separateShaderDefines_

Static Private Attributes
static const ea::vector< PropertyDesc >	properties

static const PropertyDesc	vertexDefinesProperty

static const PropertyDesc	pixelDefinesProperty

static const ea::vector< TextureUnitDesc >	textureUnits

Additional Inherited Members
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Detailed Description

SystemUI widget used to edit materials.

Member Data Documentation

◆ pixelDefinesProperty

const MaterialInspectorWidget::PropertyDesc Urho3D::MaterialInspectorWidget::pixelDefinesProperty

staticprivate

Initial value:

{
    "Pixel Defines",
    Variant{EMPTY_STRING},
    [](const Material* material) { return Variant{material->GetPixelShaderDefines()}; },
    [](Material* material, const Variant& value) { material->SetPixelShaderDefines(value.GetString()); },
    "Additional shader defines applied to pixel shader. Should be space-separated list of DEFINES. "
    "Example: VOLUMETRIC SOFTPARTICLES",
}

◆ textureUnits

const ea::vector< MaterialInspectorWidget::TextureUnitDesc > Urho3D::MaterialInspectorWidget::textureUnits

staticprivate

Initial value:

{
    {ShaderResources::Albedo,       "Albedo map or Diffuse texture with optional alpha channel."},
    {ShaderResources::Normal,       "Normal map, ignored unless normal mapping is enabled."},
    {ShaderResources::Properties,   "Roughness-Metalness-Occlusion map or Specular map."},
    {ShaderResources::Emission,     "Emission map. May also be used as AO map for legacy materials."},
    {ShaderResources::Reflection0,  "Reflection map override."},
}

◆ vertexDefinesProperty

const MaterialInspectorWidget::PropertyDesc Urho3D::MaterialInspectorWidget::vertexDefinesProperty

staticprivate

Initial value:

{
    "Vertex Defines",
    Variant{EMPTY_STRING},
    [](const Material* material) { return Variant{material->GetVertexShaderDefines()}; },
    [](Material* material, const Variant& value) { material->SetVertexShaderDefines(value.GetString()); },
    "Additional shader defines applied to vertex shader. Should be space-separated list of DEFINES. "
    "Example: VOLUMETRIC SOFTPARTICLES",
}

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

Urho3D/SystemUI/MaterialInspectorWidget.h
Urho3D/SystemUI/MaterialInspectorWidget.cpp

Classes

Public Types

Public Member Functions

Public Attributes

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Data Documentation

◆ pixelDefinesProperty

◆ textureUnits

◆ vertexDefinesProperty