Urho3D::GraphNode Class Reference

Graph node. More...

#include <Urho3D/Resource/GraphNode.h>

Inheritance diagram for Urho3D::GraphNode:

Public Member Functions
	GraphNode (Context *context)
	Construct.
	~GraphNode () override
	Destruct. Free all resources.
unsigned	GetID () const
Graph *	GetGraph () const
const ea::string &	GetName () const
StringHash	GetNameHash () const
	Return name hash.
Variant &	GetOrAddProperty (const ea::string_view name)
	Get or add node property.
Variant *	GetProperty (const ea::string_view name)
	Get node property. Returns nullptr if property is not found.
ea::span< GraphNodeProperty >	GetProperties ()
	Get properties.
GraphNode *	WithProperty (const ea::string_view name, const Variant &value)
	Add property with value.
GraphPinRef< GraphInPin >	GetInput (const ea::string_view name)
	Get input pin by name.
GraphPinRef< GraphInPin >	GetInput (unsigned index)
	Get input pin by index.
unsigned	GetNumInputs () const
	Get number of input pins.
GraphPinRef< GraphInPin >	GetOrAddInput (const ea::string_view name)
	Get or add input pin.
GraphNode *	WithInput (const ea::string_view name, VariantType type=VAR_NONE)
	Add input pin.
GraphNode *	WithInput (const ea::string_view name, const Variant &value)
	Add input pin with value.
GraphNode *	WithInput (const ea::string_view name, GraphPinRef< GraphOutPin > pin, VariantType type=VAR_NONE)
	Add input pin connected to the output pin.
GraphPinRef< GraphOutPin >	GetOrAddOutput (const ea::string_view name)
	Get or add output pin.
GraphNode *	WithOutput (const ea::string_view name, VariantType type=VAR_NONE)
	Add output pin.
GraphPinRef< GraphOutPin >	GetOutput (const ea::string_view name)
	Get output pin by name.
GraphPinRef< GraphOutPin >	GetOutput (unsigned index)
	Get output pin by index.
unsigned	GetNumOutputs () const
	Get number of output pins.
GraphPinRef< GraphEnterPin >	GetOrAddEnter (const ea::string_view name)
	Get or add enter pin.
GraphPinRef< GraphEnterPin >	GetEnter (const ea::string_view name)
	Get enter pin by name.
GraphPinRef< GraphEnterPin >	GetEnter (unsigned index)
	Get enter pin by index.
unsigned	GetNumEnters () const
	Get number of enter pins.
GraphPinRef< GraphExitPin >	GetExit (const ea::string_view name)
	Get exit pin.
GraphPinRef< GraphExitPin >	GetExit (unsigned index)
	Get enter pin by index.
GraphPinRef< GraphExitPin >	GetOrAddExit (const ea::string_view name)
	Get or add exit pin.
unsigned	GetNumExits () const
	Get number of exit pins.
void	SetName (const ea::string &name)
void	SerializeInBlock (Archive &archive) override
	Serialize content from/to archive. May throw ArchiveException.
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)
	Register object factory.
Static Public Member Functions inherited from Urho3D::Object
static const TypeInfo *	GetTypeInfoStatic ()
	Return type info static.

Protected Member Functions
void	SetGraph (Graph *scene, unsigned id)
	Set graph and id. Called by Graph.

Private Member Functions
	URHO3D_OBJECT (GraphNode, Object)

Private Attributes
ea::string	name_
	Name.
StringHash	nameHash_
	Name hash.
Graph *	graph_
	Graph.
unsigned	id_
	Unique ID within the scene.
ea::fixed_vector< GraphNodeProperty, 1 >	properties_
	User defined properties of the node.
ea::fixed_vector< GraphEnterPin, 1 >	enterPins_
	Enter pins. Define execution flow.
ea::fixed_vector< GraphExitPin, 1 >	exitPins_
	Exit pins. Define next nodes in execution flow.
ea::fixed_vector< GraphInPin, 3 >	inputPins_
	Input pins. Define source pin for the data flow.
ea::fixed_vector< GraphOutPin, 1 >	outputPins_
	Output pins. Define data flow.

Friends
class	Graph

Additional Inherited Members
Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 >	TypeHierarchy {}
Protected Attributes inherited from Urho3D::Object
WeakPtr< Context >	context_
	Execution context.

Detailed Description

Graph node.

Member Function Documentation

GetGraph()

Graph * Urho3D::GraphNode::GetGraph ( ) const

inline

Return Graph.

GetID()

unsigned Urho3D::GraphNode::GetID ( ) const

inline

Return ID.

GetName()

const ea::string & Urho3D::GraphNode::GetName ( ) const

inline

Return name.

SerializeInBlock()

void Urho3D::GraphNode::SerializeInBlock ( Archive &  archive )

overridevirtual

Serialize content from/to archive. May throw ArchiveException.

Reimplemented from Urho3D::Object.

SetName()

void Urho3D::GraphNode::SetName

(

const ea::string &

name

)

Set name of the graph node.

---

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

• Urho3D/Resource/GraphNode.h
• Urho3D/Resource/GraphNode.cpp