GH_PathOffsetOffsetPath Method (GH_Path, Int32, IGH_Structure, GH_Path, Int32)

Offset a path + index value with wrapping and bounds checking.

Namespace: Grasshopper.Kernel.Data
Assembly: Grasshopper (in Grasshopper.dll)

Syntax

public bool OffsetPath(
	GH_Path path,
	int index,
	IGH_Structure tree,
	out GH_Path relativePath,
	out int relativeIndex
)

Public Function OffsetPath ( 
	path As GH_Path,
	index As Integer,
	tree As IGH_Structure,
	<OutAttribute> ByRef relativePath As GH_Path,
	<OutAttribute> ByRef relativeIndex As Integer
) As Boolean

Parameters

path: Type: Grasshopper.Kernel.DataGH_Path
Path to offset.
index: Type: SystemInt32
Item to offset.
tree: Type: Grasshopper.Kernel.DataIGH_Structure
Structure context for offset.
relativePath: Type: Grasshopper.Kernel.DataGH_Path
Offsetted path.
relativeIndex: Type: SystemInt32
Offsetted index.

Return Value

Type: Boolean
True on success, false on failure.

Reference

GH_PathOffset Class

OffsetPath Overload

Grasshopper.Kernel.Data Namespace

GH_PathOffsetAddLanguageSpecificTextSet("LST288AC2D5_0?cpp=::|nu=.");OffsetPath Method (GH_Path, Int32, IGH_Structure, GH_PathAddLanguageSpecificTextSet("LST288AC2D5_1?cpp=%");, Int32AddLanguageSpecificTextSet("LST288AC2D5_2?cpp=%");)

Parameters

Return Value

Reference

GH_PathOffsetOffsetPath Method (GH_Path, Int32, IGH_Structure, GH_Path, Int32)