IGH_GooProxy

References

public interface IGH_GooProxy

Base interface for all type proxies.

Properties

IsParsable

bool IsParsable { get; }

Gets a value indicating whether or not the type can be instantiated from a String.

ProxyOwner

IGH_Goo ProxyOwner { get; }

Gets the piece of Grasshopper data that spawned this proxy.

UserString

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.

Returns: The UserString value or the value of FormatInstance() if UserString has not been assigned.

Valid

bool Valid { get; }

Gets a value indicating whether this proxy represents valid data.

Methods

Construct

void Construct()

This method will be called when a new instance of this type is constructed. It allows implementers to supply a customized UI to be shown during construction. This method should never throw exceptions.

FormatInstance

string FormatInstance()

Returns a String description of the current value.

Remarks: If the implementation IsParsable(), then this representation will be in parsable format.

FromString

bool FromString(string in)

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.

MutateString

string MutateString(string in)

Munge a string to remove obvious errors on account of the user.

Parameters:

in (string)