Dungeon Architect  17.0.0
Public Member Functions | Properties | Events | List of all members
DungeonArchitect.Graphs.GraphPin Class Reference

A pin is used to connect a link to a node More...

Inheritance diagram for DungeonArchitect.Graphs.GraphPin:
DungeonArchitect.Flow.Domains.Layout.Tooling.Graph2D.FlowLayoutToolGraph2DNodePin DungeonArchitect.Flow.Exec.FlowExecGraphNodePin DungeonArchitect.Grammar.GrammarNodePin

Public Member Functions

delegate void OnPinLinksDestroyed (GraphPin pin)
 
void OnEnable ()
 
GraphLink[] GetConntectedLinks ()
 Gets all the links connected to this pin More...
 
virtual bool ContainsPoint (Vector2 worldPoint)
 Checks if a point is inside the pin More...
 
Rect GetBounds ()
 Gets the bounds of the pin, relative to the node position More...
 
void NotifyPinLinksDestroyed ()
 

Properties

GraphPinMouseState ClickState [get, set]
 The state of the mouse input on this pin More...
 
GraphPinType PinType [get, set]
 The type of this pin More...
 
GraphNode Node [get, set]
 The owning graph node More...
 
Vector2 Position [get, set]
 The position of the graph pin, relative to the owning node's position More...
 
Vector2 WorldPosition [get]
 The world position of the pin More...
 
Rect BoundsOffset [get, set]
 The bounds of the pin, relative to the node's position More...
 
Vector2 Tangent [get, set]
 The tangent of the pin. Links connected to this pin would come in or out from this direction More...
 
float TangentStrength [get, set]
 The spring strength of the link connected to this pin More...
 
bool RequestLinkDeletionInitiated [get, set]
 

Events

OnPinLinksDestroyed PinLinksDestroyed
 Notifies whenever the pin is destroyed More...
 

Detailed Description

A pin is used to connect a link to a node

Definition at line 32 of file GraphPin.cs.

Member Function Documentation

◆ ContainsPoint()

virtual bool DungeonArchitect.Graphs.GraphPin.ContainsPoint ( Vector2  worldPoint)
virtual

Checks if a point is inside the pin

Parameters
worldPointThe point to test in world coordinates
Returns
true, if inside the bounds of this pin, false otherwise

Reimplemented in DungeonArchitect.Grammar.GrammarNodePin, DungeonArchitect.Flow.Domains.Layout.Tooling.Graph2D.FlowLayoutToolGraph2DNodePin, and DungeonArchitect.Flow.Exec.FlowExecGraphNodePin.

Definition at line 216 of file GraphPin.cs.

◆ GetBounds()

Rect DungeonArchitect.Graphs.GraphPin.GetBounds ( )

Gets the bounds of the pin, relative to the node position

Returns
The bounds of the pin, relative to the node position

Definition at line 236 of file GraphPin.cs.

◆ GetConntectedLinks()

GraphLink [] DungeonArchitect.Graphs.GraphPin.GetConntectedLinks ( )

Gets all the links connected to this pin

Returns
The connected links.

Definition at line 191 of file GraphPin.cs.

Property Documentation

◆ BoundsOffset

Rect DungeonArchitect.Graphs.GraphPin.BoundsOffset
getset

The bounds of the pin, relative to the node's position

Definition at line 136 of file GraphPin.cs.

◆ ClickState

GraphPinMouseState DungeonArchitect.Graphs.GraphPin.ClickState
getset

The state of the mouse input on this pin

Definition at line 38 of file GraphPin.cs.

◆ Node

GraphNode DungeonArchitect.Graphs.GraphPin.Node
getset

The owning graph node

Definition at line 84 of file GraphPin.cs.

◆ PinType

GraphPinType DungeonArchitect.Graphs.GraphPin.PinType
getset

The type of this pin

Definition at line 56 of file GraphPin.cs.

◆ Position

Vector2 DungeonArchitect.Graphs.GraphPin.Position
getset

The position of the graph pin, relative to the owning node's position

Definition at line 101 of file GraphPin.cs.

◆ Tangent

Vector2 DungeonArchitect.Graphs.GraphPin.Tangent
getset

The tangent of the pin. Links connected to this pin would come in or out from this direction

Definition at line 153 of file GraphPin.cs.

◆ TangentStrength

float DungeonArchitect.Graphs.GraphPin.TangentStrength
getset

The spring strength of the link connected to this pin

Definition at line 170 of file GraphPin.cs.

◆ WorldPosition

Vector2 DungeonArchitect.Graphs.GraphPin.WorldPosition
get

The world position of the pin

Definition at line 116 of file GraphPin.cs.

Event Documentation

◆ PinLinksDestroyed

OnPinLinksDestroyed DungeonArchitect.Graphs.GraphPin.PinLinksDestroyed

Notifies whenever the pin is destroyed

Definition at line 73 of file GraphPin.cs.

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