IGH_Goo

References

public interface IGH_Goo : GH_ISerializable

Base interface for all Data inside Grasshopper. Every parameter must implement a type of Goo.

Properties

IsValid

bool IsValid { get; }

Gets a value indicating whether or not the current value is valid.

IsValidWhyNot

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.

TypeDescription

string TypeDescription { get; }

Gets a description of the type of the implementation.

TypeName

string TypeName { get; }

Gets the name of the type of the implementation.

Methods

CastFrom

bool CastFrom(object source)

Attempt a cast from generic object

Remarks: If False, the contents of this instance are not to be trusted.

Parameters:

source (object)

Reference to source of cast.

Returns: True on success, false on failure.

CastTo<T>

bool CastTo<T>(ref T target)

Attempt a cast to type T

Remarks: If false, the target instance contents are not guaranteed to be valid.

Parameters:

target (ref T)

Pointer to target of cast.

Returns: True on success, false on failure.

Duplicate

IGH_Goo Duplicate()

Make a complete duplicate of this instance. No shallow copies.

Remarks: Classes which implement this interface should also provide type specific Duplicate methods

EmitProxy

IGH_GooProxy EmitProxy()

Create a new proxy for this instance. Return Null if this class does not support proxies.

Read

bool Read(GH_IReader reader)

This method is called whenever the instance is required to deserialize itself.

inherited fromGH_ISerializable

Parameters:

reader (GH_IReader)

Reader object to deserialize from.

Returns: True on success, false on failure.

ScriptVariable

object ScriptVariable()

This function will be called when the local IGH_Goo instance disapears into a user Script. This would be an excellent place to cast your IGH_Goo type to a simple data type.

Returns: The object that represents this IGH_Goo instance in a script.

ToString

string ToString()

Creates a string description of the current instance value

Write

bool Write(GH_IWriter writer)

This method is called whenever the instance is required to serialize itself.

inherited fromGH_ISerializable

Parameters:

writer (GH_IWriter)

Writer object to serialize with.

Returns: True on success, false on failure.