GH_Point

References

public class GH_Point : IGH_GeometricGoo, IGH_BakeAwareData, IGH_PreviewData, IGH_QuickCast

Constructors

GH_Point

public GH_Point()

GH_Point

public GH_Point(GH_Point iOther)

Parameters:

iOther (GH_Point)

GH_Point

public GH_Point(Guid rh_obj_id)

Parameters:

rh_obj_id (Guid)

GH_Point

public GH_Point(Point3d pt)

Parameters:

pt (Point3d)

Properties

Boundingbox

public BoundingBox Boundingbox { get; }

Implements: Boundingbox

ClippingBox

public BoundingBox ClippingBox { get; }

Implements: ClippingBox

IsGeometryLoaded

public bool IsGeometryLoaded { get; }

Implements: IsGeometryLoaded

IsReferencedGeometry

public bool IsReferencedGeometry { get; }

Implements: IsReferencedGeometry

IsValid

public bool IsValid { get; }

Implements: IsValid

IsValidWhyNot

public string IsValidWhyNot { get; }

Gets a string describing the state of "invalidness". If the instance is valid, then this property should return Nothing or String.Empty.

Implements: IsValidWhyNot

QC_Type

[Browsable(false)] [EditorBrowsable(EditorBrowsableState.Never)] public GH_QuickCastType QC_Type { get; }

Implements: QC_Type

ReferenceData

public GH_PointRefData ReferenceData { get; set; }

Gets or sets the reference data of this point geometry.

Remarks: Reference data can be Null

ReferenceID

public Guid ReferenceID { get; set; }

Implements: ReferenceID

TypeDescription

public string TypeDescription { get; }

Implements: TypeDescription

TypeName

public string TypeName { get; }

Implements: TypeName

Value

public Point3d Value { get; set; }

Methods

BakeGeometry

public bool BakeGeometry(RhinoDoc doc, ObjectAttributes att, ref Guid obj_guid)

Parameters:

doc (RhinoDoc)
att (ObjectAttributes)
obj_guid (ref Guid)

Implements: BakeGeometry

CastFrom

public bool CastFrom(object source)

Parameters:

source (object)

Implements: CastFrom

CastTo<T>

public bool CastTo<T>(ref T target)

Parameters:

target (ref T)

Implements: CastTo

ClearCaches

public void ClearCaches()

Implements: ClearCaches

CreateFromCoordinate

public void CreateFromCoordinate(Point3d pt)

Create a new point geometry instance based on a fixed coordinate

Remarks: This 'constructor' merely sets fields, it doesn't load the geometry and it doesn't perform validity checking.

Parameters:

pt (Point3d)

The coordinate for the point

CreateFromCurveDistance

public void CreateFromCurveDistance(Guid crv_id, Curve crv, double t, bool bFromStart)

Create new point geometry instance based on a curve distance parameter

Remarks: This 'constructor' merely sets fields, it doesn't load the geometry and it doesn't perform validity checking.

Parameters:

crv_id (Guid)	ID of the curve this object references
crv (Curve)	The curve to act on
t (double)	Parameter on the curve that controls the distance measurement
bFromStart (bool)	True if the distance is to be measured from the start of the curve

CreateFromCurveRatio

public void CreateFromCurveRatio(Guid crv_id, Curve crv, double t)

Create new point geometry instance based on a curve parameter ratio

Remarks: This 'constructor' merely sets fields, it doesn't load the geometry and it doesn't perform validity checking.

Parameters:

crv_id (Guid)	ID of the curve this object references
crv (Curve)
t (double)	Parameter on curve in domain space

CreateFromEdgeDistance

public void CreateFromEdgeDistance(Guid brp_id, Curve edge, int e_index, double t, bool bFromStart)

Create new point geometry instance based on a curve distance parameter

Remarks: This 'constructor' merely sets fields, it doesn't load the geometry and it doesn't perform validity checking.

Parameters:

brp_id (Guid)	ID of the curve this object references
edge (Curve)	The edge curve
e_index (int)	Index of edge to reference
t (double)	Parameter along the curve in curve domain space
bFromStart (bool)	True if the distance is to be measured from the start of the curve

CreateFromEdgeRatio

public void CreateFromEdgeRatio(Guid brp_id, Curve edge, int e_index, double t)

Create new point geometry instance based on an edge parameter ratio

Remarks: This 'constructor' merely sets fields, it doesn't load the geometry and it doesn't perform validity checking.

Parameters:

brp_id (Guid)	ID of the brep this object references
edge (Curve)	The edge curve
e_index (int)	Index of edge to reference
t (double)	Parameter on edge in edge domain space

CreateFromPointObject

public void CreateFromPointObject(Guid id)

Create a new point geometry instance based on point object ID. Technically this now also accepts Dot object IDs.

Remarks: This 'constructor' merely sets fields, it doesn't load the geometry and it doesn't perform validity checking.

Parameters:

id (Guid)

The identifier of the point object

CreateFromSurfaceParam

public void CreateFromSurfaceParam(Guid brp_id, int f_index, Surface srf, double u, double v)

Create new point geometry instance based on a curve distance parameter

Remarks: This 'constructor' merely sets fields, it doesn't load the geometry and it doesn't perform validity checking.

Parameters:

brp_id (Guid)	ID of the curve this object references
f_index (int)	Index of edge to reference
srf (Surface)	Surface to work on
u (double)	Parameter in surface U direction
v (double)	Parameter in surface V direction

DrawViewportMeshes

public void DrawViewportMeshes(GH_PreviewMeshArgs args)

Parameters:

args (GH_PreviewMeshArgs)

Implements: DrawViewportMeshes

DrawViewportWires

public void DrawViewportWires(GH_PreviewWireArgs args)

Parameters:

args (GH_PreviewWireArgs)

Implements: DrawViewportWires

Duplicate

public IGH_Goo Duplicate()

Implements: Duplicate

DuplicateGeometry

public IGH_GeometricGoo DuplicateGeometry()

Implements: DuplicateGeometry

DuplicatePoint

public GH_Point DuplicatePoint()

EmitProxy

public IGH_GooProxy EmitProxy()

Implements: EmitProxy

EnsureReferenceData

public void EnsureReferenceData()

Creates new Reference data if it doesn't already exists

GetBoundingBox

public BoundingBox GetBoundingBox(Transform xform)

Parameters:

xform (Transform)

Implements: GetBoundingBox

LoadGeometry

public bool LoadGeometry()

Implements: LoadGeometry

LoadGeometry

public bool LoadGeometry(RhinoDoc doc)

Parameters:

doc (RhinoDoc)

Implements: LoadGeometry

Morph

public IGH_GeometricGoo Morph(SpaceMorph xmorph)

Parameters:

xmorph (SpaceMorph)

Implements: Morph

QC_Bool

[Browsable(false)] [EditorBrowsable(EditorBrowsableState.Never)] public bool QC_Bool()

Implements: QC_Bool

QC_Col

[Browsable(false)] [EditorBrowsable(EditorBrowsableState.Never)] public Color QC_Col()

Implements: QC_Col

QC_CompareTo

public int QC_CompareTo(IGH_QuickCast other)

Parameters:

other (IGH_QuickCast)

Implements: QC_CompareTo

QC_Complex

[Browsable(false)] [EditorBrowsable(EditorBrowsableState.Never)] public Complex QC_Complex()

Implements: QC_Complex

QC_Distance

public double QC_Distance(IGH_QuickCast other)

Parameters:

other (IGH_QuickCast)

Implements: QC_Distance

QC_Hash

public int QC_Hash()

Implements: QC_Hash

QC_Int

[Browsable(false)] [EditorBrowsable(EditorBrowsableState.Never)] public int QC_Int()

Implements: QC_Int

QC_Interval

[Browsable(false)] [EditorBrowsable(EditorBrowsableState.Never)] public Interval QC_Interval()

Implements: QC_Interval

QC_Matrix

[Browsable(false)] [EditorBrowsable(EditorBrowsableState.Never)] public Matrix QC_Matrix()

Implements: QC_Matrix

QC_Num

[Browsable(false)] [EditorBrowsable(EditorBrowsableState.Never)] public double QC_Num()

Implements: QC_Num

QC_Pt

[Browsable(false)] [EditorBrowsable(EditorBrowsableState.Never)] public Point3d QC_Pt()

Implements: QC_Pt

QC_Text

[Browsable(false)] [EditorBrowsable(EditorBrowsableState.Never)] public string QC_Text()

Implements: QC_Text

QC_Vec

[Browsable(false)] [EditorBrowsable(EditorBrowsableState.Never)] public Vector3d QC_Vec()

Implements: QC_Vec

Read

public bool Read(GH_IReader reader)

Parameters:

reader (GH_IReader)

Implements: Read

ReferenceCurve

public Curve ReferenceCurve()

ReferenceCurve

public Curve ReferenceCurve(RhinoObject ref)

Parameters:

ref (RhinoObject)

ReferenceIndex

public int ReferenceIndex()

Retrieve the index of the point reference data.

Remarks: If there exists no reference data, -1 is returned.

Returns: The index of the reference data. This index describes the sub-object of the reference.

ReferenceIndex

public void ReferenceIndex(int new_index)

Sets the index of the point reference data.

Remarks: If there is no reference data, this function will create a new instance.

Parameters:

new_index (int)

The index to set. This index describes the sub-object of the reference.

ReferenceParam

public double ReferenceParam(int index)

Retrieve the indexed param of the point reference data.

Remarks: If there exists no reference data, NaN is returned.

Parameters:

index (int)

Index of parameter. Only 0 and 1 are valid values.

Returns: The indexed param of the reference data.

ReferenceParam

public void ReferenceParam(int index, double new_param)

Sets the index of the point reference data.

Remarks: If there is no reference data, this function will create a new instance.

Parameters:

index (int)	The index of the parameter. Only 0 and 1 are valid values.
new_param (double)	The new value of the parameter

ReferencesCurve

public bool ReferencesCurve()

Returns true if this point is based on a curve reference

ReferencesEdge

public bool ReferencesEdge()

Returns True if this point is based on an edge reference

ReferenceSurface

public BrepFace ReferenceSurface()

ReferenceType

public GH_PointRefType ReferenceType()

Retrieve the reference type of this point object.

Returns: The reference type as specified by the Reference Data. If there is no reference data, either Unset or Coordinate is returned depending on whether m_Point is a null reference.