Click or drag to resize

GH_Dimension Class

Represents an implementation of a Rhino dimension base class.
Inheritance Hierarchy
SystemObject
  Grasshopper.Kernel.TypesGH_GooAnnotationBase
    Grasshopper.Kernel.TypesGH_GeometricGooAnnotationBase
      Grasshopper.Kernel.TypesGH_AnnotationBase
        Grasshopper.Kernel.TypesGH_Dimension
          Grasshopper.Kernel.TypesGH_AngularDimension
          Grasshopper.Kernel.TypesGH_Centermark
          Grasshopper.Kernel.TypesGH_LinearDimension
          Grasshopper.Kernel.TypesGH_OrdinateDimension
          Grasshopper.Kernel.TypesGH_RadialDimension

Namespace:  Grasshopper.Kernel.Types
Assembly:  Grasshopper (in Grasshopper.dll)
Syntax
public abstract class GH_Dimension : GH_AnnotationBase

The GH_Dimension type exposes the following members.

Constructors
  NameDescription
Public methodGH_Dimension
Default constructor, creates an invalid dimension.
Protected methodGH_Dimension(Dimension)
Create a duplicate of an existing dimension.
Protected methodGH_Dimension(GH_Dimension)
Create a duplicate of another GH_Dimension. This constructor also copies reference data.
Public methodGH_Dimension(Guid)
Create a new referenced dimension that references a Rhino dimension with the specified ID.
Protected methodGH_Dimension(ObjRef)
Initializes a new instance of the GH_Dimension class
Protected methodGH_Dimension(Dimension, ModelAnnotationStyle)
Create a duplicate of an existing dimension.
Top
Properties
  NameDescription
Public propertyBoundingbox (Inherited from GH_AnnotationBase.)
Public propertyClippingBox (Inherited from GH_AnnotationBase.)
Public propertyIsGeometryLoaded
Gets the load state of this annotation object. The annotation is considered to be loaded when the local annotation instance is not null.
(Inherited from GH_AnnotationBase.)
Public propertyIsReferencedGeometry
Gets a value indicating whether or not this geometry is referenced. Not all IGH_GeometricGoo implementations support referenced geometry.
(Inherited from GH_GeometricGooT.)
Public propertyIsValid
Gets the validity of this dimension. If the dimension is referenced but cannot be loaded, then the dimension is not valid.
(Inherited from GH_AnnotationBase.)
Public propertyIsValidWhyNot
Gets a string describing the state of "invalidness". If the instance is valid, then this property should return Nothing or String.Empty.
(Inherited from GH_AnnotationBase.)
Public propertyReferenceID (Inherited from GH_AnnotationBase.)
Public propertyStyle (Inherited from GH_AnnotationBase.)
Public propertyTypeDescription (Inherited from GH_AnnotationBase.)
Public propertyTypeName (Inherited from GH_AnnotationBase.)
Public propertyValue
Protected propertyValueType (Overrides GH_AnnotationBaseValueType.)
Top
Methods
  NameDescription
Public methodBakeGeometry (Inherited from GH_AnnotationBase.)
Public methodCastFrom
Attempt a cast from generic object.
(Inherited from GH_GeometricGooT.)
Public methodCastToT(T)
Local to Remote caster function. This stuff is complex, don't concern yourself with casting logic.
(Inherited from GH_AnnotationBase.)
Public methodCastToT(T)
Local to Remote caster function. This stuff is complex, don't concern yourself with casting logic.
(Overrides GH_AnnotationBaseCastToT(T).)
Public methodCastToQ(Q)
Attempt a cast to type T.
(Inherited from GH_GeometricGooT.)
Public methodCastToQ(Q)
Attempt a cast to type Q.
(Inherited from GH_GooT.)
Public methodClearCaches
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 from GH_AnnotationBase.)
Public methodDrawViewportMeshes (Inherited from GH_AnnotationBase.)
Public methodDrawViewportWires (Inherited from GH_AnnotationBase.)
Public methodDuplicate (Inherited from GH_AnnotationBase.)
Public methodDuplicateAnnotation
Create a duplicate of this annotation.
(Inherited from GH_AnnotationBase.)
Public methodDuplicateGeometry
Create a duplicate of this annotation.
(Inherited from GH_AnnotationBase.)
Public methodEmitProxy
Create a new proxy for this instance. Return Null if this class does not support proxies.
(Inherited from GH_GeometricGooT.)
Public methodGetBoundingBox (Inherited from GH_AnnotationBase.)
Public methodGetOverrides (Inherited from GH_AnnotationBase.)
Public methodLoadGeometry
If the geometry is referenced and not yet loaded, attempts to load the geometry.
(Inherited from GH_AnnotationBase.)
Public methodLoadGeometry(RhinoDoc)
If the annotation is referenced and not yet loaded, attempts to load the leader.
(Inherited from GH_AnnotationBase.)
Public methodMorph (Inherited from GH_AnnotationBase.)
Public methodRead (Inherited from GH_AnnotationBase.)
Public methodScriptVariable (Inherited from GH_AnnotationBase.)
Public methodSetOverrides (Inherited from GH_AnnotationBase.)
Public methodToString
Format the dimension using default grasshopper formatting logic.
(Inherited from GH_AnnotationBase.)
Public methodTransform (Inherited from GH_AnnotationBase.)
Public methodWrite (Inherited from GH_AnnotationBase.)
Top
Fields
See Also