GH_Point.GH_PointProxy
GH_GooProxy<1>Constructors
Properties
Distance
#[Description("Reference distance along curve or edge. Only applies when point is a curve or edge reference.")]
[Category("Reference")]
[RefreshProperties(RefreshProperties.All)]
public string Distance { get; set; }
IsParsable
Gets a value indicating whether or not the type can be instantiated from a String.
Implements: IsParsable
ProxyOwner
Gets the piece of Grasshopper data that spawned this proxy.
Implements: ProxyOwner
Referenced
#[Description("Point references an object in Rhino.")]
[Category("Reference")]
public bool Referenced { get; }
ReferenceID
#[Description("Object Reference ID")]
[Category("Reference")]
[DisplayName("Reference object ID")]
public string ReferenceID { get; }
ReferenceType
#[Description("Reference Type")]
[Category("Reference")]
[DisplayName("Reference type")]
public string ReferenceType { get; }
TParameterRatio
#[Description("Reference parameter ratio along curve or edge domain. Only applies when point is a curve or edge reference.")]
[Category("Reference")]
[DisplayName("Ratio (t)")]
[RefreshProperties(RefreshProperties.All)]
public string TParameterRatio { get; set; }
TypeDescription
[Description("Description of target data type")]
[Category("Misc")]
public string TypeDescription { get; }
TypeName
UserString
Gets or sets the user-defined string that describes this proxy. This only really makes sense if the Proxy is Parsable.
Returns: The UserString value or the value of FormatInstance() if UserString has not been assigned.
Implements: UserString
UVParameterRatio
#[Description("Reference parameter ratio along surface uv domain. Only applies when point is a surface reference.")]
[Category("Reference")]
[DisplayName("Ratio (uv)")]
[RefreshProperties(RefreshProperties.All)]
public GH_PointRefUV_Wrapper UVParameterRatio { get; }
Valid
Gets a value indicating whether this proxy represents valid data.
Implements: Valid
X
#[Description("X-coordinate")]
[Category("Geometry")]
[RefreshProperties(RefreshProperties.All)]
public string X { get; set; }
Y
#[Description("Y-coordinate")]
[Category("Geometry")]
[RefreshProperties(RefreshProperties.All)]
public string Y { get; set; }
Z
#[Description("Z-coordinate")]
[Category("Geometry")]
[RefreshProperties(RefreshProperties.All)]
public string Z { get; set; }
Methods
FormatInstance
Returns a String description of the current value.
Remarks: If the implementation IsParsable(), then this representation must be in parsable format.
Implements: FormatInstance
FromString
If IsParsable(), then attempts to convert the string to a generic type value
Parameters:
| in (string) | The String to parse. |
Returns: True on success, false on failure. This method should not throw exceptions.
Implements: FromString
MutateString
Munge a string to remove obvious errors on account of the user.
Parameters:
| in (string) |
Implements: MutateString
Parameters:
| number (double) |
Parameters:
| text (string) |
ToString
Overrides: Object.ToString