T_Rhino_Geometry_RTreeEventArgs - mcneel/rhinocommon-api-docs GitHub Wiki

RTreeEventArgs Class

Represents event data that is passed when when an item that meets certain criteria is found and the passed RTree event is raised.

Inheritance Hierarchy

System.Object
  System.EventArgs
    Rhino.Geometry.RTreeEventArgs
Namespace: Rhino.Geometry
Assembly: RhinoCommon (in RhinoCommon.dll) Version: Rhino 6.0

Syntax

C#

public class RTreeEventArgs : EventArgs

VB

Public Class RTreeEventArgs
	Inherits EventArgs

The RTreeEventArgs type exposes the following members.

Properties

 

Name Description
Public property Cancel Gets or sets a value that determines if the search should be conducted farther.
Public property Id Gets the identifier of the found item.
Public property IdB If search is using two r-trees, IdB is element b in the search.
Public property IdBPtr If search is using two r-trees, IdB is the element b pointer in the search.
Public property IdPtr Gets the identifier pointer of the found item.
Public property SearchBoundingBox Bounding box bounds used during a search. You may modify the box in a search callback to help reduce the bounds to search.
Public property SearchSphere Sphere bounds used during a search. You can modify the sphere in a search callback to help reduce the bounds to search.
Public property Tag Gets or sets an arbitrary object that can be attached to this event args. This object will "stick" through a single search and can represent user-defined state.
  Back to Top

Methods

 

Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
  Back to Top

Version Information

Supported in: 6.0.16224.21491, 5D58w

See Also

Reference

Rhino.Geometry Namespace

⚠️ **GitHub.com Fallback** ⚠️