IGH_Graph

References

GH_AbstractGraph

public interface IGH_Graph : GH_ISerializable

Properties

Description

string Description { get; }

Gets the description of the graph type

GraphTypeID

Guid GraphTypeID { get; }

Gets the ID of the graph type

Grips

List<GH_GraphGrip> Grips { get; }

Gets the collection of grips that define this graph

Icon_16x16

Image Icon_16x16 { get; }

Gets the icon associated with the graph

Remarks: Icon can be null

IsValid

bool IsValid { get; }

Gets the validity of the graph instance.

Name

string Name { get; }

Gets the name of the graph type

Methods

ClearCaches

void ClearCaches()

This method will be called when it is suspected that all caches have gone stale. If your graph class uses any custom caching, override this method and clear your caches.

Draw_PostRenderGraph

void Draw_PostRenderGraph(Graphics g, GH_GraphContainer cnt)

Override this function if you want to draw something on top of the Graph curve.

Parameters:

g (Graphics)	Graphics object to draw with
cnt (GH_GraphContainer)	The container that owns this graph instance and is responsible for the drawing.

Draw_PostRenderGrid

void Draw_PostRenderGrid(Graphics g, GH_GraphContainer cnt)

Override this function if you want to draw something on top of the Graph Grid.

Parameters:

g (Graphics)	Graphics object to draw with
cnt (GH_GraphContainer)	The container that owns this graph instance and is responsible for the drawing.

Draw_PostRenderGrip

void Draw_PostRenderGrip(Graphics g, GH_GraphContainer cnt, int index)

Override this function if you want to draw something on top of the current Grip

Parameters:

g (Graphics)	Graphics object to draw with
cnt (GH_GraphContainer)	The container that owns this graph instance and is responsible for the drawing.
index (int)	The index of the grip that was just drawn

Draw_PostRenderTags

void Draw_PostRenderTags(Graphics g, GH_GraphContainer cnt)

Override this function if you want to draw something on top of the Domain tags. This function is called whether or not cnt.LockGrips is true

Parameters:

g (Graphics)	Graphics object to draw with
cnt (GH_GraphContainer)	The container that owns this graph instance and is responsible for the drawing.

Draw_PreRenderGraph

GH_GraphDrawInstruction Draw_PreRenderGraph(Graphics g, GH_GraphContainer cnt)

Override this function if you want to draw something behind of or instead of the default Graph curve

Parameters:

g (Graphics)	Graphics object to draw with
cnt (GH_GraphContainer)	The container that owns this graph instance and is responsible for the drawing.

Returns: If the return code is GH_GraphDrawInstruction.skip, the container will not draw the default Graph curve.

Draw_PreRenderGrid

GH_GraphDrawInstruction Draw_PreRenderGrid(Graphics g, GH_GraphContainer cnt)

Override this function if you want to draw something behind of or instead of the default Grid.

Parameters:

g (Graphics)	Graphics object to draw with
cnt (GH_GraphContainer)	The container that owns this graph instance and is responsible for the drawing.

Returns: If the return code is GH_GraphDrawInstruction.skip, the container will not draw the default grid.

Draw_PreRenderGrip

GH_GraphDrawInstruction Draw_PreRenderGrip(Graphics g, GH_GraphContainer cnt, int index)

Override this function if you want to draw something in addition to or instead of the current Grip

Parameters:

g (Graphics)	Graphics object to draw with
cnt (GH_GraphContainer)	The container that owns this graph instance and is responsible for the drawing.
index (int)	The index of the grip that is about to be drawn

Returns: If the return code is GH_GraphDrawInstruction.skip, the container will not draw the default grid.

Draw_PreRenderTags

GH_GraphDrawInstruction Draw_PreRenderTags(Graphics g, GH_GraphContainer cnt)

Override this function if you want to draw something behind of or instead of the default Domain tags. This function is called whether or not cnt.LockGrips is true

Parameters:

g (Graphics)	Graphics object to draw with
cnt (GH_GraphContainer)	The container that owns this graph instance and is responsible for the drawing.

Returns: If the return code is GH_GraphDrawInstruction.skip, the container will not draw the default tags.

Duplicate

IGH_Graph Duplicate()

Returns a full duplicate (perhaps minus any cache values) of the graph.

EmitProxyObject

IGH_GraphProxyObject EmitProxyObject()

Override this function if you want to be able to edit the graph through a PropertyGrid.

GDI_GraphPath

PointF[] GDI_GraphPath(RectangleF reg)

Override this function if you wish to provide a customized graphics path for the UI of the graph. The region is only provided as a reference, the returned path points should be in unit domain coordinates.

Parameters:

reg (RectangleF)

The region (in canvas coordinates) of the graph rectangle.