GH_AnnotationBase

GH_GeometricGoo<1>GH_Goo<1>References
public abstract class GH_AnnotationBase : GH_GeometricGoo<AnnotationBase>, IGH_GeometricGoo, IGH_PreviewData, IGH_BakeAwareData
Represents an implementation of a Rhino annotation base class.

Constructors

GH_AnnotationBase

#
protected GH_AnnotationBase()
Default constructor, creates an invalid annotation.

GH_AnnotationBase

#
protected GH_AnnotationBase(AnnotationBase annotation, ModelAnnotationStyle style)
Create a duplicate of an existing annotation.
Parameters:
annotation (AnnotationBase)Annotation to duplicate
style (ModelAnnotationStyle)Annotation style to use

GH_AnnotationBase

#
protected GH_AnnotationBase(AnnotationBase annotation)
Create a duplicate of an existing annotation.
Parameters:
annotation (AnnotationBase)Annotation to duplicate

GH_AnnotationBase

#
protected GH_AnnotationBase(GH_AnnotationBase other)
Create a duplicate of another GH_AnnotationBase. This constructor also copies reference data.
Parameters:
other (GH_AnnotationBase)GH_AnnotationBase to duplicate

GH_AnnotationBase

#
protected GH_AnnotationBase(Guid ref_guid)
Create a new referenced annotation that references a Rhino dimension with the specified ID.
Parameters:
ref_guid (Guid)ID of dimension object to reference.

GH_AnnotationBase

#
protected GH_AnnotationBase(ObjRef objectReference)
Parameters:
objectReference (ObjRef)

Fields

m_value

protected T m_value
inherited fromGH_Goo<T>

Properties

BoundingBox

#
public override BoundingBox BoundingBox { get; }
Overrides: GH_GeometricGoo<T>.Boundingbox

ClippingBox

#
public BoundingBox ClippingBox { get; }
Implements: ClippingBox

IsGeometryLoaded

#
public override bool IsGeometryLoaded { get; }
Gets the load state of this annotation object. The annotation is considered to be loaded when the local annotation instance is not null.
Overrides: GH_GeometricGoo<T>.IsGeometryLoaded

IsReferencedGeometry

public virtual bool IsReferencedGeometry { get; }
Gets a value indicating whether or not this geometry is referenced. Not all IGH_GeometricGoo implementations support referenced geometry.
inherited fromGH_GeometricGoo<T>
Implements: IsReferencedGeometry

IsValid

#
public override bool IsValid { get; }
Gets the validity of this dimension. If the dimension is referenced but cannot be loaded, then the dimension is not valid.
Overrides: GH_GeometricGoo<T>.IsValid

IsValidWhyNot

#
public override 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.
Overrides: GH_Goo<T>.IsValidWhyNot

Overrides

#
public ModelAnnotationStyle Overrides { get; set; }

ReferenceID

#
public override Guid ReferenceID { get; set; }
Overrides: GH_GeometricGoo<T>.ReferenceID

Style

#
public ModelAnnotationStyle Style { get; set; }

TypeDescription

#
public override string TypeDescription { get; }
Overrides: GH_Goo<T>.TypeDescription

TypeName

#
public override string TypeName { get; }
Overrides: GH_Goo<T>.TypeName

Value

#
public override AnnotationBase Value { get; set; }
Overrides: GH_GeometricGoo<T>.Value

ValueType

#
protected abstract Type ValueType { get; }

Methods

BakeGeometry

#
public bool BakeGeometry(RhinoDoc doc, ObjectAttributes att, ref Guid obj_guid)
Parameters:
doc (RhinoDoc)
att (ObjectAttributes)
obj_guid (ref Guid)
Implements: BakeGeometry

CastFrom

public override bool CastFrom(object source)
Attempt a cast from generic object.
inherited fromGH_GeometricGoo<T>
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.
Overrides: GH_Goo<T>.CastFrom

CastTo<Q>

public virtual bool CastTo<Q>(ref Q target)
Attempt a cast to type Q.
inherited fromGH_Goo<T>
Remarks: If false, the target instance contents are not guaranteed to be valid.
Parameters:
target (ref Q)Pointer to target of cast.
Returns: True on success, false on failure.
Implements: CastTo

CastTo<T>

#
public override bool CastTo<T>(ref T target)
Local to Remote caster function. This stuff is complex, don't concern yourself with casting logic.
Parameters:
target (ref T)
Overrides: GH_GeometricGoo<T>.CastTo

ClearCaches

#
public override void ClearCaches()
Clears all volatile caches for this instance. The boundingbox is cleared, and if the annotation is referenced, the local instance of the annotation is erased.
Overrides: GH_GeometricGoo<T>.ClearCaches

DrawViewportMeshes

#
public void DrawViewportMeshes(GH_PreviewMeshArgs args)
Parameters:
args (GH_PreviewMeshArgs)
Implements: DrawViewportMeshes

DrawViewportWires

#
public void DrawViewportWires(GH_PreviewWireArgs args)
Parameters:
args (GH_PreviewWireArgs)
Implements: DrawViewportWires

Duplicate

#
public override IGH_Goo Duplicate()
Overrides: GH_GeometricGoo<T>.Duplicate

DuplicateAnnotation

#
public abstract GH_AnnotationBase DuplicateAnnotation()
Create a duplicate of this annotation.

DuplicateGeometry

#
public override IGH_GeometricGoo DuplicateGeometry()
Create a duplicate of this annotation.
Overrides: GH_GeometricGoo<T>.DuplicateGeometry

EmitProxy

#
public override IGH_GooProxy EmitProxy()
Overrides: GH_GeometricGoo<T>.EmitProxy

GetBoundingBox

#
public override BoundingBox GetBoundingBox(Transform xform)
Parameters:
xform (Transform)
Overrides: GH_GeometricGoo<T>.GetBoundingBox

GetOverrides

#
[EditorBrowsable(EditorBrowsableState.Never)] public DimensionStyle GetOverrides()

LoadGeometry

#
public override bool LoadGeometry()
If the geometry is referenced and not yet loaded, attempts to load the geometry.
Returns: True if the geometry is loaded (or if it was already loaded), False on failure.
Overrides: GH_GeometricGoo<T>.LoadGeometry

LoadGeometry

#
public override bool LoadGeometry(RhinoDoc doc)
If the annotation is referenced and not yet loaded, attempts to load the leader.
Parameters:
doc (RhinoDoc)
Returns: True if the annotation is loaded (or if it was already loaded), False on failure.
Overrides: GH_GeometricGoo<T>.LoadGeometry

Morph

#
public override IGH_GeometricGoo Morph(SpaceMorph xmorph)
Parameters:
xmorph (SpaceMorph)
Overrides: GH_GeometricGoo<T>.Morph

Read

#
public override bool Read(GH_IReader reader)
Parameters:
reader (GH_IReader)
Overrides: GH_Goo<T>.Read

ScriptVariable

#
public override object ScriptVariable()
Overrides: GH_Goo<T>.ScriptVariable

SetOverrides

#
[EditorBrowsable(EditorBrowsableState.Never)] public bool SetOverrides(DimensionStyle style)
Parameters:
style (DimensionStyle)

ToString

#
public override string ToString()
Format the dimension using default grasshopper formatting logic.
Overrides: GH_Goo<T>.ToString

Transform

#
public override IGH_GeometricGoo Transform(Transform xform)
Parameters:
xform (Transform)
Overrides: GH_GeometricGoo<T>.Transform

Write

#
public override bool Write(GH_IWriter writer)
Parameters:
writer (GH_IWriter)
Overrides: GH_Goo<T>.Write