GH_Rectangle.GH_RectangleProxy

GH_GooProxy<1>
public class GH_Rectangle.GH_RectangleProxy : GH_GooProxy<GH_Rectangle>
Proxy description of GH_Rectangle class. This class is used by the Generic Multivalue interfaces.

Constructors

GH_RectangleProxy

#
public GH_RectangleProxy(GH_Rectangle nOwner)
Parameters:
nOwner (GH_Rectangle)

Properties

Area

#
[Description("Area of rectangle region")] [Category("Properties")] public string Area { get; }

Circumference

#
[Description("Circumference of rectangle region")] [Category("Properties")] public string Circumference { get; }

Height

#
[Description("Height of rectangle")] [Category("Dimensions")] [RefreshProperties(RefreshProperties.All)] public GH_Interval_Wrapper Height { get; }

IsParsable

[Browsable(false)] public virtual bool IsParsable { get; }
Gets a value indicating whether or not the type can be instantiated from a String.
inherited fromGH_GooProxy<T>
Implements: IsParsable

Origin

#
[Description("Base Plane origin")] [Category("Plane")] [RefreshProperties(RefreshProperties.All)] public GH_Point3d_Wrapper Origin { get; }

Owner

[Browsable(false)] protected T Owner { get; }
inherited fromGH_GooProxy<T>

ProxyOwner

[Browsable(false)] public IGH_Goo ProxyOwner { get; }
Gets the piece of Grasshopper data that spawned this proxy.
inherited fromGH_GooProxy<T>
Implements: ProxyOwner

TypeDescription

[Description("Description of target data type")] [Category("Misc")] public string TypeDescription { get; }
inherited fromGH_GooProxy<T>

TypeName

[Description("Name of target data type")] [Category("Misc")] public string TypeName { get; }
inherited fromGH_GooProxy<T>

UserString

[Browsable(false)] public string UserString { get; set; }
Gets or sets the user-defined string that describes this proxy. This only really makes sense if the Proxy is Parsable.
inherited fromGH_GooProxy<T>
Returns: The UserString value or the value of FormatInstance() if UserString has not been assigned.
Implements: UserString

Valid

[Description("Validity of target data")] [Category("Misc")] public virtual bool Valid { get; }
Gets a value indicating whether this proxy represents valid data.
inherited fromGH_GooProxy<T>
Implements: Valid

Width

#
[Description("Width of Rectangle")] [Category("Dimensions")] [RefreshProperties(RefreshProperties.All)] public GH_Interval_Wrapper Width { get; }

XAxis

#
[Description("Plane X-Axis")] [Category("Plane")] [DisplayName("X Axis")] [RefreshProperties(RefreshProperties.All)] public GH_Vector3d_Wrapper XAxis { get; }

YAxis

#
[Description("Plane Y-Axis")] [Category("Plane")] [DisplayName("Y Axis")] [RefreshProperties(RefreshProperties.All)] public GH_Vector3d_Wrapper YAxis { get; }

ZAxis

#
[Description("Plane Z-Axis")] [Category("Plane")] [DisplayName("Z Axis")] [RefreshProperties(RefreshProperties.All)] public GH_Vector3d_Wrapper ZAxis { get; }

Methods

Construct

#
public override void Construct()
Overrides: GH_GooProxy<T>.Construct

FormatInstance

public virtual string FormatInstance()
Returns a String description of the current value.
inherited fromGH_GooProxy<T>
Remarks: If the implementation IsParsable(), then this representation must be in parsable format.
Implements: FormatInstance

FromString

public virtual bool FromString(string in)
If IsParsable(), then attempts to convert the string to a generic type value
inherited fromGH_GooProxy<T>
Parameters:
in (string)The String to parse.
Returns: True on success, false on failure. This method should not throw exceptions.
Implements: FromString

MutateString

public virtual string MutateString(string in)
Munge a string to remove obvious errors on account of the user.
inherited fromGH_GooProxy<T>
Parameters:
in (string)
Implements: MutateString

NumberToString

protected string NumberToString(double number)
inherited fromGH_GooProxy<T>
Parameters:
number (double)

StringToNumber

protected double StringToNumber(string text)
inherited fromGH_GooProxy<T>
Parameters:
text (string)

ToString

public override string ToString()
inherited fromGH_GooProxy<T>
Overrides: Object.ToString