I3T

Appearance

Core::Pin ​

Pin used for connecting nodes. More...

#include "Core/Nodes/Pin.h"

Public Functions ​

Name
Pin(EValueType valueType, bool isInput, Node & owner, int index)
const Data &data() const<br>Get stored data based on pin type.
Data &dataMut()
const std::string &getLabel() const
const std::vector< Pin * > &getOutComponents() const
Ptr< Node >getOwner() const
const Pin *getParentPin() const
std::stringgetSignature() const<br>"pin {index} of {node signature}"
boolisDisabled() const
boolisPluggedIn() const<br>Query if input of this object is plugged to any parent output.
boolisRendered() const<br>False in Camera P and V matrices ONLY.
voidsetDisabled(bool disabled)
voidsetRendered(bool value)
ENodePlugResultisPlugCorrect(const Pin & input, const Pin & output)

Public Attributes ​

Name
IDId
const intIndex <br>Index within a node.
const boolIsInput <br>Pin type.
Node &Owner
const EValueTypeValueType

Friends ​

Name
classNode

Detailed Description ​

cpp
class Core::Pin;
class Core::Pin;

Pin used for connecting nodes.

OperatorCurveTab from I3T v1.

Public Functions Documentation ​

function Pin ​

cpp
Pin(
    EValueType valueType,
    bool isInput,
    Node & owner,
    int index
)
Pin(
    EValueType valueType,
    bool isInput,
    Node & owner,
    int index
)

function data ​

cpp
const Data & data() const
const Data & data() const

Get stored data based on pin type.

Return: data storage owner by node connected to this input pin. If pin is output pin, it returns data storage of pin owner.

Precondition: If pin is input, it must be plugged to some output pin.

function dataMut ​

cpp
Data & dataMut()
Data & dataMut()

function getLabel ​

cpp
const std::string & getLabel() const
const std::string & getLabel() const

function getOutComponents ​

cpp
inline const std::vector< Pin * > & getOutComponents() const
inline const std::vector< Pin * > & getOutComponents() const

Return: Input pins of connected nodes.

function getOwner ​

cpp
Ptr< Node > getOwner() const
Ptr< Node > getOwner() const

function getParentPin ​

cpp
const Pin * getParentPin() const
const Pin * getParentPin() const

Return: nullptr if input is not plugged in.

function getSignature ​

cpp
std::string getSignature() const
std::string getSignature() const

"pin {index} of {node signature}"

function isDisabled ​

cpp
inline bool isDisabled() const
inline bool isDisabled() const

function isPluggedIn ​

cpp
bool isPluggedIn() const
bool isPluggedIn() const

Query if input of this object is plugged to any parent output.

Return: True if plugged to parent, false if not.

function isRendered ​

cpp
inline bool isRendered() const
inline bool isRendered() const

False in Camera P and V matrices ONLY.

Used to skip hidden values stored as pins.

function setDisabled ​

cpp
inline void setDisabled(
    bool disabled
)
inline void setDisabled(
    bool disabled
)

function setRendered ​

cpp
inline void setRendered(
    bool value
)
inline void setRendered(
    bool value
)

function isPlugCorrect ​

cpp
static ENodePlugResult isPlugCorrect(
    const Pin & input,
    const Pin & output
)
static ENodePlugResult isPlugCorrect(
    const Pin & input,
    const Pin & output
)

Public Attributes Documentation ​

variable Id ​

cpp
ID Id;
ID Id;

variable Index ​

cpp
const int Index = -1;
const int Index = -1;

Index within a node.

variable IsInput ​

cpp
const bool IsInput;
const bool IsInput;

Pin type.

variable Owner ​

cpp
Node & Owner;
Node & Owner;

variable ValueType ​

cpp
const EValueType ValueType = EValueType::Pulse;
const EValueType ValueType = EValueType::Pulse;

Friends ​

friend Node ​

cpp
friend class Node(
    Node 
);
friend class Node(
    Node 
);

Updated on 2024-03-16 at 19:15:01 +0000