GridGraphEditor Class Reference

Public Types
enum	GridPivot {   Center, TopLeft, TopRight, BottomLeft,   BottomRight }

Public Member Functions
override void	OnInspectorGUI (NavGraph target)
	Override to implement graph inspectors.
override void	OnSceneGUI (NavGraph target)
	Override to implement scene GUI drawing for the graph.
void	SnapSizeToNodes (int newWidth, int newDepth, GridGraph graph)
Public Member Functions inherited from GraphEditor
bool	AutoScan ()
	Called by editor scripts to rescan the graphs e.g when the user moved a graph.
void	OnBaseInspectorGUI (NavGraph target)
	Draws common graph settings.
virtual void	OnDrawGizmos ()
	Override to implement scene Gizmos drawing for the graph editor.
virtual void	OnEnable ()
bool	ToggleGroup (string label, bool value)
	Draws a toggle with a bold label to the right.
virtual void	UnloadGizmoMeshes ()

Static Public Member Functions
static GridPivot	PivotPointSelector (GridPivot pivot)
static Vector3	RoundVector3 (Vector3 v)
	Rounds a vector's components to whole numbers if very close to them.
Static Public Member Functions inherited from GraphEditor
static void	DrawWireCube (Vector3 center, Vector3 size)
	Draws a wire cube using handles.
static bool	FixLabel (string label, string buttonLabel="Fix", int buttonWidth=40)
	Draws a small help box with a 'Fix' button to the right.
static void	HelpBox (string label)
	Draws a small help box.
static Object	ObjectField (string label, Object obj, System.Type objType, bool allowSceneObjects)
static Object	ObjectField (GUIContent label, Object obj, System.Type objType, bool allowSceneObjects)
static void	Separator ()
	Draws a thin separator line.
static bool	ToggleGroup (GUIContent label, bool value)
	Draws a toggle with a bold label to the right.

Public Attributes
bool	isMouseDown
bool	locked = true
GridPivot	pivot
bool	showExtra
Public Attributes inherited from GraphEditor
AstarPathEditor	editor
FadeArea	fadeArea
	Stores if the graph is visible or not in the inspector.
FadeArea	infoFadeArea
	Stores if the graph info box is visible or not in the inspector.
Public Attributes inherited from GraphEditorBase
NavGraph	target
	NavGraph this editor is exposing.

Protected Member Functions
virtual void	DrawCollisionEditor (GraphCollision collision)
	Draws the inspector for a GraphCollision class .
virtual void	DrawCutCorners (GridGraph graph)
void	DrawErosion (GridGraph graph)
virtual void	DrawJPS (GridGraph graph)
virtual void	DrawMaxClimb (GridGraph graph)
void	DrawMaxSlope (GridGraph graph)
virtual void	DrawMiddleSection (GridGraph graph)
virtual void	DrawNeighbours (GridGraph graph)
virtual void	DrawTextureData (GridGraph.TextureData data, GridGraph graph)
	Draws settings for using a texture as source for a grid.
virtual void	DrawUse2DPhysics (GraphCollision collision)

Static Protected Attributes
static readonly string[]	ChannelUseNames = { "None", "Penalty", "Height", "Walkability and Penalty" }

Private Member Functions
void	DrawFirstSection (GridGraph graph)
void	DrawIsometricField (GridGraph graph)
void	DrawLastSection (GridGraph graph)
void	DrawPenaltyModifications (GridGraph graph)
void	DrawPositionField (GridGraph graph)
void	DrawWidthDepthFields (GridGraph graph)

Static Private Member Functions
static void	SaveReferenceTexture (GridGraph graph)

Private Attributes
float	newNodeSize
Matrix4x4	savedMatrix

Static Private Attributes
static GUIStyle	gridPivotSelectBackground
	Cached gui style.
static GUIStyle	gridPivotSelectButton
	Cached gui style.
static GUIStyle	lockStyle
	Cached gui style.
static readonly float	standardIsometric = 90-Mathf.Atan(1/Mathf.Sqrt(2))*Mathf.Rad2Deg

Member Enumeration Documentation

enum GridPivot

Enumerator:

Center
TopLeft
TopRight
BottomLeft
BottomRight

Member Function Documentation

virtual void DrawCollisionEditor ( GraphCollision  collision )

protectedvirtual

Draws the inspector for a GraphCollision class .

Reimplemented in LayerGridGraphEditor.

virtual void DrawCutCorners ( GridGraph  graph )

protectedvirtual

Reimplemented in LayerGridGraphEditor.

void DrawErosion ( GridGraph  graph )

protected

void DrawFirstSection ( GridGraph  graph )

private

void DrawIsometricField ( GridGraph  graph )

private

virtual void DrawJPS ( GridGraph  graph )

protectedvirtual

Reimplemented in LayerGridGraphEditor.

void DrawLastSection ( GridGraph  graph )

private

virtual void DrawMaxClimb ( GridGraph  graph )

protectedvirtual

Reimplemented in LayerGridGraphEditor.

void DrawMaxSlope ( GridGraph  graph )

protected

virtual void DrawMiddleSection ( GridGraph  graph )

protectedvirtual

Reimplemented in LayerGridGraphEditor.

virtual void DrawNeighbours ( GridGraph  graph )

protectedvirtual

Reimplemented in LayerGridGraphEditor.

void DrawPenaltyModifications ( GridGraph  graph )

private

void DrawPositionField ( GridGraph  graph )

private

virtual void DrawTextureData ( GridGraph.TextureData  data, GridGraph  graph  )

protectedvirtual

Draws settings for using a texture as source for a grid.

A* Pro Feature:

This is an A* Pathfinding Project Pro feature only. This function/class/variable might not exist in the Free version of the A* Pathfinding Project or the functionality might be limited
The Pro version can be bought here

Reimplemented in LayerGridGraphEditor.

virtual void DrawUse2DPhysics ( GraphCollision  collision )

protectedvirtual

Reimplemented in LayerGridGraphEditor.

void DrawWidthDepthFields ( GridGraph  graph )

private

override void OnInspectorGUI ( NavGraph  target )

virtual

Override to implement graph inspectors.

Reimplemented from GraphEditor.

Reimplemented in LayerGridGraphEditor.

override void OnSceneGUI ( NavGraph  target )

virtual

Override to implement scene GUI drawing for the graph.

Reimplemented from GraphEditor.

static GridPivot PivotPointSelector ( GridPivot  pivot )

static

static Vector3 RoundVector3 ( Vector3  v )

static

Rounds a vector's components to whole numbers if very close to them.

static void SaveReferenceTexture ( GridGraph  graph )

staticprivate

void SnapSizeToNodes	(	int	newWidth,
		int	newDepth,
		GridGraph	graph
	)

Member Data Documentation

readonly string [] ChannelUseNames = { "None", "Penalty", "Height", "Walkability and Penalty" }

staticprotected

GUIStyle gridPivotSelectBackground

staticprivate

Cached gui style.

GUIStyle gridPivotSelectButton

staticprivate

Cached gui style.

bool isMouseDown

bool locked = true

GUIStyle lockStyle

staticprivate

Cached gui style.

float newNodeSize

private

GridPivot pivot

Matrix4x4 savedMatrix

private

bool showExtra

readonly float standardIsometric = 90-Mathf.Atan(1/Mathf.Sqrt(2))*Mathf.Rad2Deg

staticprivate

---

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

• /Users/arong/Unity/a-pathfinding-project/Assets/AstarPathfindingProject/Editor/GraphEditors/GridGeneratorEditor.cs