GH_Document.RelevantObjectAtPoint Method (PointF, GH_RelevantObjectFilter)

GH_DocumentRelevantObjectAtPoint Method (PointF, GH_RelevantObjectFilter)

Find the most relevant object at a given canvas location. The most relevant object might be a regular Object (Component or Parameter), it might be an attribute grip, an attribute balloon, a wire or a group.

Namespace:  Grasshopper.Kernel
Assembly:  Grasshopper (in Grasshopper.dll)
Syntax
Copy
public GH_RelevantObjectData RelevantObjectAtPoint(
	PointF pt,
	GH_RelevantObjectFilter searchFilter
)
Public Function RelevantObjectAtPoint ( 
	pt As PointF,
	searchFilter As GH_RelevantObjectFilter
) As GH_RelevantObjectData

Parameters

pt
Type: System.DrawingPointF
The point to test.
searchFilter
Type: Grasshopper.KernelGH_RelevantObjectFilter

Return Value

Type: GH_RelevantObjectData
Information about the most relevant object or Null if no relevant object could be found at the given point.
See Also

M:Grasshopper.Kernel.GH_Document.RelevantObjectAtPoint(System.Drawing.PointF,Grasshopper.Kernel.GH_RelevantObjectFilter)