Pin of a node in particle graph. More...

#include <Urho3D/Particles/ParticleGraphPin.h>

Inheritance diagram for Urho3D::ParticleGraphPin:

Public Member Functions
	ParticleGraphPin ()
	Construct default pin.

	ParticleGraphPin (ParticleGraphPinFlags flags, const ea::string &name, VariantType type=VAR_NONE, ParticleGraphContainerType container=ParticleGraphContainerType::Auto)
	Construct pin.

	ParticleGraphPin (ParticleGraphPinFlags flags, const ea::string &name, ParticleGraphContainerType container)
	Construct pin.

bool	IsInput () const
	Get input pin flag.

ParticleGraphPinFlags	GetFlags () const
	Get pin flags.

const ea::string &	GetName () const
	Name of the pin for visual editor.

StringHash	GetNameHash () const
	Name hash of the pin.

VariantType	GetRequestedType () const
	Requested value type of the pin. VAR_NONE for autodetected value type.

VariantType	GetValueType () const
	Value type of the pin evaluated at the runtime.

unsigned	GetAttributeIndex () const
	Get attribute index for sparse span.

ParticleGraphPinRef	GetMemoryReference () const
	Get reference to memory descriptor for the pin.

ParticleGraphContainerType	GetContainerType () const

ParticleGraphPin	WithType (VariantType type) const
	Get a copy of the pin setup but with a different value type.

bool	SetSource (unsigned nodeIndex, unsigned pinIndex=0)
	Set source node and pin indices.

bool	GetConnected () const
	Get true if connected to node.

unsigned	GetConnectedNodeIndex () const
	Get connected node index.

unsigned	GetConnectedPinIndex () const
	Get connected pin index.

Protected Member Functions
bool	SetName (const ea::string &name)
	Set pin name and hash.

bool	SetValueType (VariantType valueType)
	Set pin value type.

void	SetIsInput (bool isInput)
	Get input pin flag.

Private Attributes
ParticleGraphContainerType	containerType_ {ParticleGraphContainerType::Auto}
	Container type: span, sparse or scalar.

VariantType	valueType_ {VAR_NONE}
	Value type at runtime.

ea::string	name_
	Name of the pin for visual editor.

StringHash	nameHash_
	Pin name hash.

unsigned	sourceNode_
	Source node.

unsigned	sourcePin_ {}
	Source node pin index.

ParticleGraphPinFlags	flags_ {ParticleGraphPinFlag::Input}
	Is input pin.

VariantType	requestedValueType_ {VAR_NONE}
	Value type (float, vector3, etc).

unsigned	attributeIndex_ {}
	Index of attribute. Only valid for sparse pins.

ParticleGraphPinRef	memory_
	Reference to a memory block that corresponds to the pin value.

Friends
class	ParticleGraphAttributeBuilder

class	ParticleGraphNode

Detailed Description

Pin of a node in particle graph.

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

Public Member Functions