GH_LinearDimension

GH_DimensionGH_AnnotationBaseGH_GeometricGoo<1>GH_Goo<1>References
public class GH_LinearDimension : GH_Dimension
Represents an implementation of a Rhino linear dimension.

Constructors

GH_LinearDimension

#
public GH_LinearDimension()
Default constructor, creates an invalid linear dimension.

GH_LinearDimension

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

GH_LinearDimension

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

GH_LinearDimension

#
public GH_LinearDimension(LinearDimension dimension, ModelAnnotationStyle style)
Create a duplicate of an existing linear dimension.
Parameters:
dimension (LinearDimension)Linear dimension to duplicate
style (ModelAnnotationStyle)Annotation style to use

GH_LinearDimension

#
public GH_LinearDimension(LinearDimension dimension)
Create a duplicate of an existing linear dimension.
Parameters:
dimension (LinearDimension)Linear dimension to duplicate

Fields

m_value

protected T m_value
inherited fromGH_Goo<T>

Properties

BoundingBox

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

ClippingBox

public BoundingBox ClippingBox { get; }
inherited fromGH_AnnotationBase
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.
inherited fromGH_AnnotationBase
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.
inherited fromGH_AnnotationBase
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.
inherited fromGH_AnnotationBase
Overrides: GH_Goo<T>.IsValidWhyNot

Overrides

public ModelAnnotationStyle Overrides { get; set; }
inherited fromGH_AnnotationBase

ReferenceID

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

TypeDescription

#
public override string TypeDescription { get; }
Overrides: GH_AnnotationBase.TypeDescription

TypeName

#
public override string TypeName { get; }
Overrides: GH_AnnotationBase.TypeName

Value

#
public LinearDimension Value { get; set; }

ValueType

#
protected override Type ValueType { get; }
Overrides: GH_Dimension.ValueType

Methods

BakeGeometry

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

CastFrom

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

CastTo<Q>

public override bool CastTo<Q>(ref Q target)
Attempt a cast to type T.
inherited fromGH_GeometricGoo<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.
Overrides: GH_Goo<T>.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_Dimension.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.
inherited fromGH_AnnotationBase
Overrides: GH_GeometricGoo<T>.ClearCaches

DrawViewportMeshes

public void DrawViewportMeshes(GH_PreviewMeshArgs args)
inherited fromGH_AnnotationBase
Parameters:
args (GH_PreviewMeshArgs)
Implements: DrawViewportMeshes

DrawViewportWires

public void DrawViewportWires(GH_PreviewWireArgs args)
inherited fromGH_AnnotationBase
Parameters:
args (GH_PreviewWireArgs)
Implements: DrawViewportWires

Duplicate

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

DuplicateAnnotation

#
public override GH_AnnotationBase DuplicateAnnotation()
Create a duplicate of this annotation.
Overrides: GH_AnnotationBase.DuplicateAnnotation

DuplicateGeometry

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

DuplicateLinearDimension

#
public GH_LinearDimension DuplicateLinearDimension()
Create a duplicate of this linear dimension.

EmitProxy

public override IGH_GooProxy EmitProxy()
inherited fromGH_Dimension
Overrides: GH_AnnotationBase.EmitProxy

GetBoundingBox

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

LoadGeometry

public override bool LoadGeometry()
If the geometry is referenced and not yet loaded, attempts to load the geometry.
inherited fromGH_AnnotationBase
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.
inherited fromGH_AnnotationBase
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)
inherited fromGH_AnnotationBase
Parameters:
xmorph (SpaceMorph)
Overrides: GH_GeometricGoo<T>.Morph

Read

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

ScriptVariable

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

SetOverrides

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

ToString

#
public override string ToString()
Format the dimension using default grasshopper formatting logic.
Overrides: GH_AnnotationBase.ToString

Transform

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

Write

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