Click or drag to resize

Linetype Class

[Missing <summary> documentation for "T:Rhino.DocObjects.Linetype"]

Inheritance Hierarchy

Namespace:  Rhino.DocObjects
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
[SerializableAttribute]
public sealed class Linetype : ModelComponent

The Linetype type exposes the following members.

Constructors
  NameDescription
Public methodLinetype
Initializes a new instance of the Linetype class
Public methodLinetype(Linetype)
Initializes a new instance of the Linetype class
Top
Properties
  NameDescription
Public propertyAlwaysModelDistances
Linetype patterns and widths are typically interpreted as distances on the printed output when printing. In this case AlwaysModelDistances is false (default). When set to true, the linetype pattern and width will be interpreted as being in world distances. This is useful for cases like modeling a road as a single curve.
Public propertyComponentStatus
Gets or sets the component status of the model component.
(Inherited from ModelComponent.)
Public propertyComponentType
Returns LinePattern.
(Overrides ModelComponentComponentType.)
Public propertyDeletedName
Gets the name of a component that is deleted.
(Inherited from ModelComponent.)
Public propertyDisposed
Indicates if this object has been disposed or the document it originally belonged to has been disposed.
(Inherited from CommonObject.)
Public propertyHasId
Returns a value indicating whether the component has an ID.
(Inherited from ModelComponent.)
Public propertyHasIndex
Returns a value indicating whether the component has an Index.
(Inherited from ModelComponent.)
Public propertyHasName
Returns a value indicating whether the component has a Name.
(Inherited from ModelComponent.)
Public propertyHasUserData
Gets true if this class has any custom information attached to it through UserData.
(Inherited from CommonObject.)
Public propertyId
Gets or sets the ID of the current instance.
(Inherited from ModelComponent.)
Public propertyIdIsLocked
Returns a value indicating whether the component ID is already locked.
(Inherited from ModelComponent.)
Public propertyIndex
Gets or sets the model component index attribute.
(Inherited from ModelComponent.)
Public propertyIndexIsLocked
Returns a value indicating whether the component Index is already locked.
(Inherited from ModelComponent.)
Public propertyInstanceDefinitionModelSerialNumber
When a component is in a model as part of the information required for a linked instance definition, this value identifies the linked instance definition reference model.
(Inherited from ModelComponent.)
Public propertyInUse
Returns true if the linetype is in use by a Rhino object, a layer, an instance definition, or a section style.
Public propertyIsComponentStatusLocked
The component status itself can be locked. This returns an indication.
(Inherited from ModelComponent.)
Public propertyIsDeleted
Gets a value indicating whether this linetype has been deleted and is currently in the Undo buffer.
(Overrides ModelComponentIsDeleted.)
Public propertyIsDocumentControlled
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 CommonObject.)
Public propertyIsModified
true if this linetype has been modified by LinetypeTable.ModifyLinetype() and the modifications can be undone.
Public propertyIsPatternLocked
Returns true if the pattern is locked and cannot be modified.
Public propertyIsReference
Gets a value indicting whether this linetype is a referenced linetype. Referenced linetypes are part of referenced documents.
(Overrides ModelComponentIsReference.)
Public propertyIsSystemComponent
True if this model component is a system constant.

An incomplete list of system constant model components is below:

  • ON_ModelComponent::Unset

  • ON_InstanceDefinition::Empty

  • ON_Linetype::Unset
  • ON_Linetype::Continuous
  • ON_Linetype::ByLayer
  • ON_Linetype::ByParent

  • ON_Layer::Unset
  • ON_Layer::Default

  • ON_TextStyle::Unset
  • ON_TextStyle::Default
  • ON_TextStyle::ByLayer
  • ON_TextStyle::ByParent

  • ON_DimStyle::Unset
  • ON_DimStyle::Default
  • ON_DimStyle::DefaultInchDecimal
  • ON_DimStyle::DefaultInchFractional
  • ON_DimStyle::DefaultFootInchArchitecture
  • ON_DimStyle::DefaultMillimeterSmall
  • ON_DimStyle::DefaultMillimeterLarge
  • ON_DimStyle::DefaultMillimeterArchitecture
(Inherited from ModelComponent.)
Public propertyIsValid
Tests an object to see if it is valid.
(Inherited from CommonObject.)
Public propertyLineCapStyle
Defines how the ends of open curves should be drawn
Public propertyLineJoinStyle
Defines how the corners of curves should be drawn
Public propertyModelSerialNumber
A value identifying the model that manages this component.
(Inherited from ModelComponent.)
Public propertyName
The name of this linetype.
(Overrides ModelComponentName.)
Public propertyNameIsLocked
Returns a value indicating whether the component Name is already locked.
(Inherited from ModelComponent.)
Public propertyPatternLength
Total length of one repeat of the pattern.
Public propertyReferenceModelSerialNumber
When a component is in a model for reference, this value identifies the reference model.
(Inherited from ModelComponent.)
Public propertySegmentCount
Number of segments in the pattern.
Public propertyUserData
List of custom information that is attached to this class.
(Inherited from CommonObject.)
Public propertyUserDictionary
Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use shareable set of information.
(Inherited from CommonObject.)
Public propertyUserStringCount
Gets the amount of user strings.
Public propertyWidth
Base width for this linetype
Public propertyWidthUnits
Unit system that widths are defined in. UnitSystem.None is default and means that the width is defined in pixels.
Top
Methods
  NameDescription
Public methodAppendSegment
Adds a segment to the pattern.
Public methodClearId
Resets the HasId property of the model component to false, if possible.
(Inherited from ModelComponent.)
Public methodClearIndex
Resets the HasIndex property of the model component to false, if possible.
(Inherited from ModelComponent.)
Public methodClearName
Resets the HasName property of the model component to false, if possible.
(Inherited from ModelComponent.)
Public methodCommitChanges
Public methodStatic memberCreateFromPatternString
Creates a linetype from a pattern string. Values greater than zero represent line segments, and values less than or equal to zero represents space segments.
Public methodDataCRC
Increments the Cyclic Redundancy Check value by this instance.
(Inherited from ModelComponent.)
Public methodDefault
Set linetype to default settings.
Public methodDeleteAllUserStrings
Public methodDeleteUserString
Public methodDispose
Actively reclaims unmanaged resources that this instance uses.
(Inherited from CommonObject.)
Public methodDuplicateLinetype
Duplicates a linetype, clears the name, id, and locked bits.
Public methodEnsurePrivateCopy
If you want to keep a copy of this class around by holding onto it in a variable after a command completes, call EnsurePrivateCopy to make sure that this class is not tied to the document. You can call this function as many times as you want.
(Inherited from CommonObject.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetObjectData
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
(Inherited from CommonObject.)
Public methodGetSegment
Gets the segment information at a index.
Public methodGetTaperPoints
Taper points are positions/width combinations along the length of a curve
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUserString
Gets user string from this geometry.
Public methodGetUserStrings
Gets a copy of all (user key string, user value string) pairs attached to this geometry.
Public methodIsValidWithLog
Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.
(Inherited from CommonObject.)
Public methodLockId
Locks the component Id property.
(Inherited from ModelComponent.)
Public methodLockIndex
Locks the component Index property.
(Inherited from ModelComponent.)
Public methodLockName
Locks the component Name property.
(Inherited from ModelComponent.)
Public methodPatternString
Returns a string that represents the pattern of the linetype, which can be used in user interface. Values greater than zero represent line segments, and values less than or equal to zero represent space segments.
Public methodStatic memberReadFromFile
Reads linetypes from either a Rhino .3dm file or an AutoCAD .lin file.
Public methodRemoveSegment
Removes a segment in the linetype.
Public methodRemoveTaper
Remove taper information for stroke
Public methodSetSegment
Sets the length and type of the segment at index.
Public methodSetSegments
Set all segments.
Public methodSetTaper(Double, Double)
Set taper to a simple start width / end width
Public methodSetTaper(Double, Point2d, Double)
Set taper for this linetype width a single internal taper point
Public methodSetUserString
Attach a user string (key,value combination) to this geometry.
Public methodToJSON
Create a JSON string representation of this object
(Inherited from CommonObject.)
Public methodToString
Returns the name of the model component type, and then its name and index.
(Inherited from ModelComponent.)
Top
See Also