The grid class used for creating quadrilateral or hexagonal grids. More...

Inheritance diagram for WMG_Grid:

Public Types
enum	gridTypes { gridTypes.quadrilateral, gridTypes.hexagonal_flat_top, gridTypes.hexagonal_flat_side }

Public Types inherited from WMG_Text_Functions
enum	WMGpivotTypes { WMGpivotTypes.Bottom, WMGpivotTypes.BottomLeft, WMGpivotTypes.BottomRight, WMGpivotTypes.Center, WMGpivotTypes.Left, WMGpivotTypes.Right, WMGpivotTypes.Top, WMGpivotTypes.TopLeft, WMGpivotTypes.TopRight }

Public Member Functions
void	Refresh ()
	Refreshes this grid, if a grid property has changed from its previously cached value. More...

List< WMG_Node >	getColumn (int colNum)
	Gets the specified column of nodes given a column index. More...

void	setActiveColumn (bool active, int colNum)
	Sets active the specified column of nodes given a column index. More...

List< WMG_Node >	getRow (int rowNum)
	Gets the specified row of nodes given a row index. More...

void	setActiveRow (bool active, int rowNum)
	Sets active the specified row of nodes given a column index. More...

List< GameObject >	GetNodesAndLinks ()
	Gets all the nodes and links of this grid. More...

Public Member Functions inherited from WMG_Graph_Manager
GameObject	CreateNode (Object prefabNode, GameObject parent)
	Creates a node for this graph. More...

GameObject	CreateLink (WMG_Node fromNode, GameObject toNode, Object prefabLink, GameObject parent)
	Creates a link for this graph, and repositions the link. More...

GameObject	CreateLinkNoRepos (WMG_Node fromNode, GameObject toNode, Object prefabLink, GameObject parent)
	Creates a link for this graph, and does not repoisition the link. More...

WMG_Link	GetLink (WMG_Node fromNode, WMG_Node toNode)
	Given two nodes, get the link between those nodes for this graph. More...

GameObject	ReplaceNodeWithNewPrefab (WMG_Node theNode, Object prefabNode)
	Given a node, and a prefab, re-instantiate the node using the specified prefab which has a WMG_Node script attached. More...

void	DeleteNode (WMG_Node theNode)
	Deletes a node. More...

void	DeleteLink (WMG_Link theLink)
	Deletes a link. More...

List< WMG_Link >	FindShortestPathBetweenNodes (WMG_Node fromNode, WMG_Node toNode)
	Given two nodes return one or more shortest paths between the nodes based on the number of links (unweighted), using Breadth-first search algorithm. More...

List< WMG_Link >	FindShortestPathBetweenNodesWeighted (WMG_Node fromNode, WMG_Node toNode, bool includeRadii)
	Given two nodes return one or more shortest paths between the nodes based on the link weights (weighted), and also node radii if include radii is true, using Dijkstra's algorithm. More...

Public Member Functions inherited from WMG_Events
delegate void	WMG_Click_H (WMG_Series aSeries, WMG_Node aNode, PointerEventData pointerEventData)

void	addNodeClickEvent (GameObject go)

delegate void	WMG_Link_Click_H (WMG_Series aSeries, WMG_Link aLink, PointerEventData pointerEventData)

void	addLinkClickEvent (GameObject go)

delegate void	WMG_Click_Leg_H (WMG_Series aSeries, WMG_Node aNode, PointerEventData pointerEventData)

void	addNodeClickEvent_Leg (GameObject go)

delegate void	WMG_Link_Click_Leg_H (WMG_Series aSeries, WMG_Link aLink, PointerEventData pointerEventData)

void	addLinkClickEvent_Leg (GameObject go)

delegate void	WMG_Pie_Slice_Click_H (WMG_Pie_Graph pieGraph, WMG_Pie_Graph_Slice aSlice, PointerEventData pointerEventData)

void	addPieSliceClickEvent (GameObject go)

delegate void	WMG_Pie_Legend_Entry_Click_H (WMG_Pie_Graph pieGraph, WMG_Legend_Entry legendEntry, PointerEventData pointerEventData)

void	addPieLegendEntryClickEvent (GameObject go)

delegate void	WMG_Ring_Click_H (WMG_Ring ring, PointerEventData pointerEventData)

void	addRingClickEvent (GameObject go)

delegate void	WMG_MouseEnter_H (WMG_Series aSeries, WMG_Node aNode, bool state)

void	addNodeMouseEnterEvent (GameObject go)

delegate void	WMG_Link_MouseEnter_H (WMG_Series aSeries, WMG_Link aLink, bool state)

void	addLinkMouseEnterEvent (GameObject go)

delegate void	WMG_MouseEnter_Leg_H (WMG_Series aSeries, WMG_Node aNode, bool state)

void	addNodeMouseEnterEvent_Leg (GameObject go)

delegate void	WMG_Link_MouseEnter_Leg_H (WMG_Series aSeries, WMG_Link aLink, bool state)

void	addLinkMouseEnterEvent_Leg (GameObject go)

delegate void	WMG_Pie_Slice_MouseEnter_H (WMG_Pie_Graph pieGraph, WMG_Pie_Graph_Slice aSlice, bool state)

void	addPieSliceMouseEnterEvent (GameObject go)

delegate void	WMG_Ring_MouseEnter_H (WMG_Ring ring, bool state)

void	addRingMouseEnterEvent (GameObject go)

void	addNodeMouseLeaveEvent (GameObject go)

void	addLinkMouseLeaveEvent (GameObject go)

void	addNodeMouseLeaveEvent_Leg (GameObject go)

void	addLinkMouseLeaveEvent_Leg (GameObject go)

Public Member Functions inherited from WMG_GUI_Functions
void	SetActive (GameObject obj, bool state)

bool	activeInHierarchy (GameObject obj)

void	SetActiveAnchoredSprite (GameObject obj, bool state)

void	SetActiveImage (GameObject obj, bool state)

Texture2D	getTexture (GameObject obj)

void	setTexture (GameObject obj, Sprite sprite)

void	changeSpriteFill (GameObject obj, float fill)

void	changeRadialSpriteRotation (GameObject obj, Vector3 newRot)

void	changeSpriteColor (GameObject obj, Color aColor)

void	changeSpriteAlpha (GameObject obj, float alpha)

float	getSpriteAlpha (GameObject obj)

void	changeSpriteWidth (GameObject obj, int aWidth)

void	changeSpriteHeight (GameObject obj, int aHeight)

void	setTextureMaterial (GameObject obj, Material aMat)

Material	getTextureMaterial (GameObject obj)

void	changeSpriteSize (GameObject obj, int aWidth, int aHeight)

void	changeSpriteSizeFloat (GameObject obj, float aWidth, float aHeight)

Vector2	getSpriteSize (GameObject obj)

void	changeBarWidthHeight (GameObject obj, int aWidth, int aHeight)

float	getSpriteWidth (GameObject obj)

float	getSpriteHeight (GameObject obj)

float	getTextWidth (GameObject obj)

float	getTextHeight (GameObject obj)

void	forceUpdateText (GameObject obj)

void	setAnchor (GameObject go, Vector2 anchor, Vector2 pivot, Vector2 anchoredPosition)

void	setAnchoredPosition (GameObject go, Vector2 anchoredPosition)

void	stretchToParent (GameObject go)

bool	rectIntersectRect (GameObject r1, GameObject r2)

void	getRectDiffs (GameObject child, GameObject container, ref Vector2 xDif, ref Vector2 yDif)

float	getSpritePositionX (GameObject obj)

float	getSpritePositionY (GameObject obj)

Vector2	getSpritePositionXY (GameObject obj)

float	getSpritePivotTopToBot (GameObject obj)

Vector3	getPositionRelativeTransform (GameObject obj, GameObject relative)

void	changePositionByRelativeTransform (GameObject obj, GameObject relative, Vector2 delta)

void	changeSpritePositionTo (GameObject obj, Vector3 newPos)

void	changeSpritePositionToX (GameObject obj, float newPos)

void	changeSpritePositionToY (GameObject obj, float newPos)

Vector2	getChangeSpritePositionTo (GameObject obj, Vector2 newPos)

void	changeSpritePositionRelativeToObjBy (GameObject obj, GameObject relObj, Vector3 changeAmt)

void	changeSpritePositionRelativeToObjByX (GameObject obj, GameObject relObj, float changeAmt)

void	changeSpritePositionRelativeToObjByY (GameObject obj, GameObject relObj, float changeAmt)

Vector2	getSpritePivot (GameObject obj)

void	changeSpriteParent (GameObject child, GameObject parent)

void	getFirstCanvasOnSelfOrParent (Transform trans, ref Canvas canv)

void	addRaycaster (GameObject obj)

void	setAsNotInteractible (GameObject obj)

void	bringSpriteToFront (GameObject obj)

void	sendSpriteToBack (GameObject obj)

Public Member Functions inherited from WMG_Text_Functions
void	changeLabelText (GameObject obj, string aText)

void	changeLabelFontSize (GameObject obj, int newFontSize)

Vector2	getTextSize (GameObject obj)

void	changeSpritePivot (GameObject obj, WMGpivotTypes theType)

void	changeLabelColor (GameObject obj, Color newColor)

void	changeLabelFontStyle (GameObject obj, FontStyle newFontStyle)

void	changeLabelFont (GameObject obj, Font newFont)

Public Attributes
bool	autoRefresh = true
	Automatically refreshes the grid, if a parameter has changed from its previously cached value. More...

gridTypes	gridType
	Determines whether a grid is quadrilateral or hexagonal. More...

Object	nodePrefab
	The prefab used to instantiate nodes of the grid. More...

Object	linkPrefab
	The prefab used to instantiate links of the grid. More...

int	gridNumNodesX
	The number of nodes in the x dimension. More...

int	gridNumNodesY
	The number of nodes in the y dimension. More...

float	gridLinkLengthX
	The amount of space between the nodes in the x direction. More...

float	gridLinkLengthY
	The amount of space between the nodes in the y direction. More...

bool	createLinks
	Whether or not links are created between nodes in the grid. More...

bool	noVerticalLinks
	If createLinks = true, this determines whether links are only created in the horizontal direction. More...

bool	noHorizontalLinks
	If createLinks = true, this determines whether links are only created in the vertical direction. More...

Color	linkColor = Color.white
	The color of the links. More...

int	linkWidth
	The width of the links. More...

Additional Inherited Members
Properties inherited from WMG_Graph_Manager
List< GameObject >	NodesParent `[get]`
	The list of GameObjects which are WMG_Nodes for this graph. More...

List< GameObject >	LinksParent `[get]`
	The list of GameObjects which are WMG_Links for this graph. More...

Events inherited from WMG_Events
WMG_Click_H	WMG_Click
	Occurs when a series point is clicked. More...

WMG_Link_Click_H	WMG_Link_Click
	Occurs when a series link / line is clicked. More...

WMG_Click_Leg_H	WMG_Click_Leg
	Occurs when a series legend node / swatch is clicked. More...

WMG_Link_Click_Leg_H	WMG_Link_Click_Leg
	Occurs when a series legend link / line is clicked. More...

WMG_Pie_Slice_Click_H	WMG_Pie_Slice_Click
	Occurs when a pie graph slice is clicked. More...

WMG_Pie_Legend_Entry_Click_H	WMG_Pie_Legend_Entry_Click
	Occurs when a pie graph legend swatch is clicked. More...

WMG_Ring_Click_H	WMG_Ring_Click
	Occurs when a ring graph ring / band is clicked. More...

WMG_MouseEnter_H	WMG_MouseEnter
	Occurs when a series point is hovered. More...

WMG_Link_MouseEnter_H	WMG_Link_MouseEnter
	Occurs when a series link / line is hovered. More...

WMG_MouseEnter_Leg_H	WMG_MouseEnter_Leg
	Occurs when a series legend node / swatch is hovered. More...

WMG_Link_MouseEnter_Leg_H	WMG_Link_MouseEnter_Leg
	Occurs when a series legend link / line is hovered. More...

WMG_Pie_Slice_MouseEnter_H	WMG_Pie_Slice_MouseEnter
	Occurs when a pie graph slice is hovered. More...

WMG_Ring_MouseEnter_H	WMG_Ring_MouseEnter
	Occurs when a ring graph ring / band is hovered. More...

Detailed Description

The grid class used for creating quadrilateral or hexagonal grids.

Member Enumeration Documentation

◆ gridTypes

enum WMG_Grid.gridTypes

strong

Enumerator
quadrilateral
hexagonal_flat_top
hexagonal_flat_side

Member Function Documentation

◆ getColumn()

List<WMG_Node> WMG_Grid.getColumn ( int colNum )

Gets the specified column of nodes given a column index.

Returns: The column.

Parameters

colNum Col number.

◆ GetNodesAndLinks()

List<GameObject> WMG_Grid.GetNodesAndLinks ( )

Gets all the nodes and links of this grid.

Returns: The nodes and links.

◆ getRow()

List<WMG_Node> WMG_Grid.getRow ( int rowNum )

Gets the specified row of nodes given a row index.

Returns: The row.

Parameters

rowNum Row number.

◆ Refresh()

void WMG_Grid.Refresh ( )

Refreshes this grid, if a grid property has changed from its previously cached value.

◆ setActiveColumn()

void WMG_Grid.setActiveColumn	(	bool	active,
		int	colNum
	)

Sets active the specified column of nodes given a column index.

Parameters

active	If set to `true` active.
colNum	Col number.

◆ setActiveRow()

void WMG_Grid.setActiveRow	(	bool	active,
		int	rowNum
	)

Sets active the specified row of nodes given a column index.

Parameters

active	If set to `true` active.
rowNum	Row number.

Member Data Documentation

◆ autoRefresh

bool WMG_Grid.autoRefresh = true

Automatically refreshes the grid, if a parameter has changed from its previously cached value.

◆ createLinks

bool WMG_Grid.createLinks

Whether or not links are created between nodes in the grid.

◆ gridLinkLengthX

float WMG_Grid.gridLinkLengthX

The amount of space between the nodes in the x direction.

◆ gridLinkLengthY

float WMG_Grid.gridLinkLengthY

The amount of space between the nodes in the y direction.

◆ gridNumNodesX

int WMG_Grid.gridNumNodesX

The number of nodes in the x dimension.

◆ gridNumNodesY

int WMG_Grid.gridNumNodesY

The number of nodes in the y dimension.

◆ gridType

gridTypes WMG_Grid.gridType

Determines whether a grid is quadrilateral or hexagonal.

◆ linkColor

Color WMG_Grid.linkColor = Color.white

The color of the links.

◆ linkPrefab

Object WMG_Grid.linkPrefab

The prefab used to instantiate links of the grid.

◆ linkWidth

int WMG_Grid.linkWidth

The width of the links.

◆ nodePrefab

Object WMG_Grid.nodePrefab

The prefab used to instantiate nodes of the grid.

◆ noHorizontalLinks

bool WMG_Grid.noHorizontalLinks

If createLinks = true, this determines whether links are only created in the vertical direction.

◆ noVerticalLinks

bool WMG_Grid.noVerticalLinks

If createLinks = true, this determines whether links are only created in the horizontal direction.

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

C:/Users/Stuart/Documents/Unity Projects/Graph Maker 5.0.1/Assets/Graph_Maker/Scripts/Graphs/WMG_Grid.cs

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ gridTypes

Member Function Documentation

◆ getColumn()

◆ GetNodesAndLinks()

◆ getRow()

◆ Refresh()

◆ setActiveColumn()

◆ setActiveRow()

Member Data Documentation

◆ autoRefresh

◆ createLinks

◆ gridLinkLengthX

◆ gridLinkLengthY

◆ gridNumNodesX

◆ gridNumNodesY

◆ gridType

◆ linkColor

◆ linkPrefab

◆ linkWidth

◆ nodePrefab

◆ noHorizontalLinks

◆ noVerticalLinks