IGH_GeometricGoo

References
public interface IGH_GeometricGoo : IGH_Goo
Base interface for all Data inside Grasshoper that could pass for Geometry

Properties

Boundingbox

#
BoundingBox Boundingbox { get; }
Gets the (cached) boundingbox for this geometry. Not all geometry types cache boundingbox results.
Returns: The boundingbox for this piece of geometry or Boundingbox.Empty if the geometry is null or invalid.

IsGeometryLoaded

#
bool IsGeometryLoaded { get; }
Gets a value indicating whether or not this geometry is currently loaded (assuming it is referenced). Not all IGH_GeometricGoo implementations support referenced geometry.

IsReferencedGeometry

#
bool IsReferencedGeometry { get; }
Gets a value indicating whether or not this geometry is referenced. Not all IGH_GeometricGoo implementations support referenced geometry.

IsValid

bool IsValid { get; }
Gets a value indicating whether or not the current value is valid.
inherited fromIGH_Goo

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.
inherited fromIGH_Goo

ReferenceID

#
Guid ReferenceID { get; set; }
Gets or sets the Guid of the object that is referenced. Not all IGH_GeometricGoo implementations support referenced geometry.

TypeDescription

string TypeDescription { get; }
Gets a description of the type of the implementation.
inherited fromIGH_Goo

TypeName

string TypeName { get; }
Gets the name of the type of the implementation.
inherited fromIGH_Goo

Methods

CastFrom

bool CastFrom(object source)
Attempt a cast from generic object
inherited fromIGH_Goo
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
inherited fromIGH_Goo
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.

ClearCaches

#
void ClearCaches()
Clears all caches. Typically if the geometry is referenced, this will erase the local copy.

Duplicate

IGH_Goo Duplicate()
Make a complete duplicate of this instance. No shallow copies.
inherited fromIGH_Goo
Remarks: Classes which implement this interface should also provide type specific Duplicate methods

DuplicateGeometry

#
IGH_GeometricGoo DuplicateGeometry()
Make a complete duplicate of this geometry. No shallow copies.
Remarks: Each class that implements this interface should also provide a type specific duplication method

EmitProxy

IGH_GooProxy EmitProxy()
Create a new proxy for this instance. Return Null if this class does not support proxies.
inherited fromIGH_Goo

GetBoundingBox

#
BoundingBox GetBoundingBox(Transform xform)
Compute an aligned boundingbox.
Parameters:
xform (Transform)Transformation to apply to geometry for BoundingBox computation.
Returns: The world aligned boundingbox of the transformed geometry.

LoadGeometry

#
bool LoadGeometry()
If the geometry is referenced and currently unloaded, forces loading of the geometry. Not all IGH_GeometricGoo implementations support referenced geometry.

LoadGeometry

#
bool LoadGeometry(RhinoDoc doc)
If the geometry is referenced and currently unloaded, forces loading of the geometry. Not all IGH_GeometricGoo implementations support referenced geometry.
Parameters:
doc (RhinoDoc)Document to use for loading.

Morph

#
IGH_GeometricGoo Morph(SpaceMorph xmorph)
Morph the object or a deformable representation of the object.
Parameters:
xmorph (SpaceMorph)Spatial deform.
Returns: Deformed geometry. If the local geometry can be deformed accurately, then the returned instance equals this instance. Not all geometry types can be accurately deformed though, if this is the case, this function will return an instance of another IGH_GeometricGoo derived type which can be deformed.

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.
inherited fromIGH_Goo
Returns: The object that represents this IGH_Goo instance in a script.

ToString

string ToString()
Creates a string description of the current instance value
inherited fromIGH_Goo

Transform

#
IGH_GeometricGoo Transform(Transform xform)
Transforms the object or a deformable representation of the object.
Parameters:
xform (Transform)Transformation matrix.
Returns: Transformed geometry. If the local geometry can be transformed accurately, then the returned instance equals this instance. Not all geometry types can be accurately transformed under all circumstances though, if this is the case, this function will return an instance of another IGH_GeometricGoo derived type which can be transformed.

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.