ax::NodeEditor::Utilities::BlueprintNodeBuilder Class Reference

Node Builder class. More...

Public Member Functions
void	Begin (ax::NodeEditor::NodeId id)
	Begins building a node.
	BlueprintNodeBuilder (ImTextureID texture=nullptr, int textureWidth=0, int textureHeight=0)
	Constructor.
void	End ()
	Ends building a node.
void	EndHeader ()
	Ends building the header.
void	Header (const ImVec4 &color=ImVec4(1, 1, 1, 1))
	Begins building the header.
void	Input (ax::NodeEditor::PinId id)
	Begins building an input pin.
void	Middle ()
	Begins building of the middle of the node.
void	Output (ax::NodeEditor::PinId id)
	Begins building an output pin.

Static Public Member Functions
static void	EndInput ()
	Ends building the input pin.
static void	EndOutput ()
	Ends building the output pin.

Private Types
enum class	Stage : uint8_t {   Invalid ,   Begin ,   Header ,   Content ,   Input ,   Output ,   Middle ,   End }
	Stages in the build process. More...

Private Member Functions
bool	SetStage (Stage stage)
	Set the stage of the node build process. Takes care of all the Layout elements.

Static Private Member Functions
static void	EndPin ()
	Ends building the pin.
static void	Pin (ax::NodeEditor::PinId id, ax::NodeEditor::PinKind kind)
	Begins building a pin.

Private Attributes
ImVec2	ContentMax
	Maximum size of the content.
ImVec2	ContentMin
	Minimum size of the content.
NodeId	CurrentNodeId
	Id of the node currently built.
Stage	CurrentStage
	Current stage of the build process.
bool	HasHeader
	Flag whether the node has a header.
ImU32	HeaderColor
	Color of the header.
ImVec2	HeaderMax
	Maximum size of the header.
ImVec2	HeaderMin
	Minimum size of the header.
int	HeaderTextureHeight
	Height of the header texture.
ImTextureID	HeaderTextureId
	Pointer to the texture to use for the header.
int	HeaderTextureWidth
	Width of the header texture.
ImVec2	NodeMax
	Maximum size of the node.
ImVec2	NodeMin
	Minimum size of the node.

Detailed Description

Node Builder class.

Member Enumeration Documentation

Stage

enum class ax::NodeEditor::Utilities::BlueprintNodeBuilder::Stage : uint8_t

strongprivate

Stages in the build process.

Enumerator
Invalid	Invalid stage.
Begin	Beginning of node construction.
Header	Currently building the header.
Content	Currently building the content.
Input	Currently building an input pin.
Output	Currently building an output pin.
Middle	Currently building the middle.
End	End of node construction.

Constructor & Destructor Documentation

BlueprintNodeBuilder()

ax::NodeEditor::Utilities::BlueprintNodeBuilder::BlueprintNodeBuilder ( ImTextureID texture = nullptr, int textureWidth = 0, int textureHeight = 0 )

explicit

Constructor.

Parameters

[in]	texture	Pointer to the texture to use for the node
[in]	textureWidth	Width of the provided texture
[in]	textureHeight	Height of the provided texture

Member Function Documentation

Begin()

void ax::NodeEditor::Utilities::BlueprintNodeBuilder::Begin

(

ax::NodeEditor::NodeId

id

)

Begins building a node.

Parameters

[in]

id

Id of the node to build

Header()

void ax::NodeEditor::Utilities::BlueprintNodeBuilder::Header

(

const ImVec4 &

color = ImVec4(1, 1, 1, 1)

)

Begins building the header.

Parameters

[in]

color

Color of the header

Input()

void ax::NodeEditor::Utilities::BlueprintNodeBuilder::Input

(

ax::NodeEditor::PinId

id

)

Begins building an input pin.

Parameters

[in]

id

Id of the pin to build

Output()

void ax::NodeEditor::Utilities::BlueprintNodeBuilder::Output

(

ax::NodeEditor::PinId

id

)

Begins building an output pin.

Parameters

[in]

id

Id of the pin to build

Pin()

static void ax::NodeEditor::Utilities::BlueprintNodeBuilder::Pin ( ax::NodeEditor::PinId id, ax::NodeEditor::PinKind kind )

staticprivate

Begins building a pin.

Parameters

[in]	id	Id of the pin to build
[in]	kind	Kind of the pin (input/output)

SetStage()

bool ax::NodeEditor::Utilities::BlueprintNodeBuilder::SetStage ( Stage stage )

private

Set the stage of the node build process. Takes care of all the Layout elements.

Parameters

[in]

stage

Stage to set

Returns

True if stage was set correctly

---

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

• /home/runner/work/INSTINCT/INSTINCT/src/internal/gui/panels/BlueprintNodeBuilder.hpp