T_Rhino_Geometry_RLeader - mcneel/rhinocommon-api-docs GitHub Wiki

RLeader Class

Leader geometry class

Inheritance Hierarchy

System.Object
  Rhino.Runtime.CommonObject
    Rhino.Geometry.GeometryBase
      Rhino.Geometry.RLeader
Namespace: Rhino.Geometry
Assembly: RhinoCommon (in RhinoCommon.dll) Version: Rhino 6.0

Syntax

C#

[SerializableAttribute]
public class RLeader : GeometryBase

VB

<SerializableAttribute>
Public Class RLeader
	Inherits GeometryBase

The RLeader type exposes the following members.

Constructors

 

Name Description
Public method RLeader Constructotr
  Back to Top

Properties

 

Name Description
Public property ContentType Type of annotation on the leader Currently only text
Public property Curve Gets the curve used by this leader
Public property DimstyleId Get or set the id of this leader's dimstyle
Public property HasBrepForm Returns true if the Brep.TryConvertBrep function will be successful for this object (Inherited from GeometryBase.)
Public property IsDeformable true if object can be accurately modified with "squishy" transformations like projections, shears, and non-uniform scaling. (Inherited from GeometryBase.)
Public property IsDocumentControlled If true this object may not be modified. Any properties or functions that attempt to modify this object when it is set to "IsReadOnly" will throw a NotSupportedException. (Inherited from GeometryBase.)
Public property ObjectType Useful for switch statements that need to differentiate between basic object types like points, curves, surfaces, and so on. (Inherited from GeometryBase.)
Public property Plane Get and set Leaders Plane
Public property Points2D Get or set the 2d points defining the curve used by this leader
Public property Points3D Get or set the 3d points defining the curve used by this leader
Public property TextHeight Set or get the text height for this leader
Public property TextString Return text string for this leader
Public property UserStringCount Gets the amount of user strings. (Inherited from GeometryBase.)
  Back to Top

Methods

 

Name Description
Public method ComponentIndex If this piece of geometry is a component in something larger, like a BrepEdge in a Brep, then this function returns the component index. (Inherited from GeometryBase.)
Public methodStatic member Create Creates a RLeader geometry object
Protected method Dispose(Boolean) Overridden in order to destroy local display cache information (Inherited from GeometryBase.)
Public method Duplicate Constructs a deep (full) copy of this object. (Inherited from GeometryBase.)
Public method DuplicateShallow Constructs a light copy of this object. By "light", it is meant that the same underlying data is used until something is done to attempt to change it. For example, you could have a shallow copy of a very heavy mesh object and the same underlying data will be used when doing things like inspecting the number of faces on the mesh. If you modify the location of one of the mesh vertices, the shallow copy will create a full duplicate of the underlying mesh data and the shallow copy will become a deep copy. (Inherited from GeometryBase.)
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodCode example GetBoundingBox(Boolean) Boundingbox solver. Gets the world axis aligned boundingbox for the geometry. (Inherited from GeometryBase.)
Public methodCode example GetBoundingBox(Plane) Aligned Boundingbox solver. Gets the plane aligned boundingbox. (Inherited from GeometryBase.)
Public method GetBoundingBox(Transform) Aligned Boundingbox solver. Gets the world axis aligned boundingbox for the transformed geometry. (Inherited from GeometryBase.)
Public method GetBoundingBox(Plane, Box) Aligned Boundingbox solver. Gets the plane aligned boundingbox. (Inherited from GeometryBase.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetUserString Gets user string from this geometry. (Inherited from GeometryBase.)
Public method GetUserStrings Gets a copy of all (user key string, user value string) pairs attached to this geometry. (Inherited from GeometryBase.)
Public method MakeDeformable If possible, converts the object into a form that can be accurately modified with "squishy" transformations like projections, shears, an non-uniform scaling. (Inherited from GeometryBase.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method MemoryEstimate Computes an estimate of the number of bytes that this object is using in memory. (Inherited from GeometryBase.)
Protected method NonConstOperation Destroy cache handle (Inherited from GeometryBase.)
Protected method OnSwitchToNonConst Is called when a non-const operation occurs. (Inherited from GeometryBase.)
Public method Rotate Rotates the object about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule). (Inherited from GeometryBase.)
Public method Scale Scales the object by the specified factor. The scale is centered at the origin. (Inherited from GeometryBase.)
Public method SetTextString Sets the text string for this leader
Public method SetUserString Attach a user string (key,value combination) to this geometry. (Inherited from GeometryBase.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method Transform Transforms the geometry. If the input Transform has a SimilarityType of OrientationReversing, you may want to consider flipping the transformed geometry after calling this function when it makes sense. For example, you may want to call Flip() on a Brep after transforming it. (Inherited from GeometryBase.)
Public method Translate(Vector3d) Translates the object along the specified vector. (Inherited from GeometryBase.)
Public method Translate(Double, Double, Double) Translates the object along the specified vector. (Inherited from GeometryBase.)
  Back to Top

Version Information

Supported in: 6.0.16224.21491

See Also

Reference

Rhino.Geometry Namespace

⚠️ **GitHub.com Fallback** ⚠️