Rhino.DocObjectsnamespace

The DocObjects namespace contains types that correspond to geometry that is found in a document.

Generally, these types reference an attribute and have a distinctive ID.

Types

ActiveSpace

Since v5.0
Rhino.DocObjects.ActiveSpace
Defines the current working space.
Rhino.DocObjects.AngleDisplayMode
Defines enumerated values for the display of angles.
Rhino.DocObjects.AngularDimensionObject
Rhino Object that represents an angular dimension geometry and attributes
Rhino.DocObjects.AnimationProperties
Contains information used by the Animation Tools to create sun, season, turntable and fly through animations.
Rhino.DocObjects.AnimationProperties.CaptureTypes
Constants that define the mode of the animation tools.
Rhino.DocObjects.AnnotationObjectBase
Base class for all annotation objects (text and dimensions)

BasepointZero

Since v5.0 Obsolete v8.6
Rhino.DocObjects.BasepointZero
Specifies enumerated constants used to indicate the zero level convention relating to a location on Earth.

This is used in conjunction with the EarthAnchorPoint class.

Rhino.DocObjects.BitmapEntry
Rhino.DocObjects.Tables.BitmapTable entry
Rhino.DocObjects.BrepObject
Represents a Brep in a document.
Rhino.DocObjects.CentermarkObject
Rhino Object that represents a centermark geometry and attributes
Rhino.DocObjects.ClippingPlaneObject
Represents the object of a clipping plane, stored in the Rhino document and with attributes.
Rhino.DocObjects.ConstructionPlane
Represents a construction plane inside the document.

Use Rhino.DocObjects.Tables.NamedConstructionPlaneTable methods and indexers to add and access a ConstructionPlane.

Rhino.DocObjects.ConstructionPlaneGridDefaults
Default grid settings for a document
Rhino.DocObjects.CoordinateSystem
Defines enumerated values for coordinate systems to use as references.
Rhino.DocObjects.CurveObject
A Rhino Object that represents curve geometry and attributes
Rhino.DocObjects.DetailViewObject
A detail view object is a nested Rhino viewport placed on a page view with a 2D closed curve boundary. It can be any type of modeling view.
Rhino.DocObjects.DetailViewObject.ScaleFormat
Detail view object scale formats.
Rhino.DocObjects.DimensionObject
Rhino Object that represents dimension geometry and attributes
Rhino.DocObjects.DimensionStyle
Can also be considered an annotation style since it is used for more than just dimensions
Rhino.DocObjects.DimensionStyle.AngleDisplayFormat
Display format for angles
Rhino.DocObjects.DimensionStyle.ArrowFit
Arrow display position inside or outside extension lines
Rhino.DocObjects.DimensionStyle.ArrowType
Defines enumerated values for arrowhead shapes.
Rhino.DocObjects.DimensionStyle.CenterMarkStyle
Style for drawing centermark for Radial dimensions and Centermark objects
Rhino.DocObjects.DimensionStyle.ClippingArrowType
Defines enumerated values for arrowhead shapes.
Rhino.DocObjects.DimensionStyle.Field
Field identifiers used for file i/o and getting/setting values
Rhino.DocObjects.DimensionStyle.LeaderContentAngleStyle
Angle for text or other leader or dimension content
Rhino.DocObjects.DimensionStyle.LeaderCurveStyle
Type of leader curve
Rhino.DocObjects.DimensionStyle.LengthDisplay
Dimension display length unit system and style
Rhino.DocObjects.DimensionStyle.LengthDisplayFormat
Obsolete format for length display - use ON_DimStyle::DimensionLengthDisplay instead
Rhino.DocObjects.DimensionStyle.MaskFrame
Draw a frame stroke around the text mask area
Rhino.DocObjects.DimensionStyle.MaskType
Text mask drawn with background color or explicit color
Rhino.DocObjects.DimensionStyle.StackDisplayFormat
Format of stacked fractions
Rhino.DocObjects.DimensionStyle.TextFit
Text display position inside or outside extension lines
Rhino.DocObjects.DimensionStyle.TextLocation
The location of text in linear, angular, radial, and ordinate dimensions.
Rhino.DocObjects.DimensionStyle.ToleranceDisplayFormat
Style of tolerance display for dimensions
Rhino.DocObjects.DimensionStyle.ZeroSuppression
Marks leading and trailing zeros for removal.

DisplayMode

Since v5.0
Rhino.DocObjects.DisplayMode
Defines enumerated values for display modes, such as wireframe or shaded.

DistanceDisplayMode

Since v5.0 Obsolete v8.35
Rhino.DocObjects.DistanceDisplayMode
Defines enumerated values for the display of distances in US customary and Imperial units.
Rhino.DocObjects.EarthAnchorPoint
Contains information about the model's position in latitude, longitude, and elevation for GIS mapping applications.
Rhino.DocObjects.EarthCoordinateSystem
ON::EarthCoordinateSystem identifies the standard used to define Earth latitude, longitude, and elevation coordinates.
Rhino.DocObjects.Environment
Represents an environment.
Rhino.DocObjects.Environment.BackgroundProjections
The available background projections.
Rhino.DocObjects.ExtrusionObject
Rhino.DocObjects.Font
Defines a format for text.
Rhino.DocObjects.Font.FontOrigin
Platform where font originated. This information is useful when searching for appropriate substitutes.
Rhino.DocObjects.Font.FontStretch
Horizontal expansion or contraction of font
Rhino.DocObjects.Font.FontStyle
Vertical angle of font Upright, Italic, or Oblique
Rhino.DocObjects.Font.FontType
An enum that reports if the font face is available on the current device.
Rhino.DocObjects.Font.FontWeight
Weight enum values Avoid casting these values to int. Use ON_Font::WindowsLogfontWeightFromWeight() or ON_Font::AppleWeightOfFontFromWeight() or add another converter.
Rhino.DocObjects.FontQuartet
Rhino.DocObjects.GripObject
Rhino.DocObjects.Group

HatchLine

Since v8.0
Rhino.DocObjects.HatchLine
Hatch lines are used by hatch pattern to specify the dashes and offset patterns of the lines.
Rhino.DocObjects.HatchObject
Rhino.DocObjects.HatchPattern
Rhino.DocObjects.HatchPattern.Defaults
Rhino.DocObjects.HatchPatternFillType
Rhino.DocObjects.HistoryRecord
Provides a single bundling of information to be passed to Rhino when setting up history for an object.
Rhino.DocObjects.InstanceDefinition
This is the same as InstanceDefinitionGeometry, but in a Rhino document.
Rhino.DocObjects.InstanceDefinitionArchiveFileStatus
The archive file of a linked instance definition can have the following possible states. Use InstanceObject.ArchiveFileStatus to query a instance definition's archive file status.
Rhino.DocObjects.InstanceDefinitionLayerStyle
InstanceDefinition.LayerStyle specifies how model components (layers, materials, dimension styles, etc.) from linked instance definition files appear in the active model.
Rhino.DocObjects.InstanceDefinitionNameConflictResolution
Specifies how to resolve a name collision when an instance definition is created from a file and the model already contains an instance definition with that name.
Rhino.DocObjects.InstanceDefinitionUpdateType
The possible relationships between the instance definition geometry and the archive containing the original definition.
Rhino.DocObjects.InstanceObject

ItemColorSource

Since v9.0
Rhino.DocObjects.ItemColorSource
Color source for a per-item color override on object attributes (for example, hatch boundary color or hatch pattern color). Selects whether the color is read from the layer, from the object's main attribute color, inherited from the parent, or read from a custom override color stored on the attribute itself.
Rhino.DocObjects.Layer
Rhino.DocObjects.LeaderObject
Rhino Object that represents leader geometry and attributes
Rhino.DocObjects.LightObject
Rhino.DocObjects.LinearDimensionObject
Rhino Object that represents a linear dimension geometry and attributes
Rhino.DocObjects.LineCapStyle
Shape to be used at the ends of open curves
Rhino.DocObjects.LineJoinStyle
Shape to be used at the corners of curves
Rhino.DocObjects.Linetype
Rhino.DocObjects.Markup
Markup elements that store image data when users create markups
Rhino.DocObjects.Material
Rhino.DocObjects.MaterialRef
Rhino.DocObjects.MaterialRefCreateParams
Options passed to MaterialRefs.Create
Rhino.DocObjects.MaterialRefs
If you are developing a high quality plug-in renderer, and a user is assigning a custom render material to this object, then add rendering material information to the MaterialRefs dictionary. Note to developers: As soon as the MaterialRefs dictionary contains items rendering material queries slow down. Do not populate the MaterialRefs dictionary when setting the MaterialIndex will take care of your needs.
Rhino.DocObjects.MeshObject
Rhino.DocObjects.ModelComponent
Base class for all components in a model (document) and manages the index, id and other information common to this type of objects.

This class parallels the C++ ON_ModelComponent.

Rhino.DocObjects.ModelComponentType
The ON_ModelComponent::Type enum has a value for each explicit component type and two special values, Unset and Mixed. Use an ON_ModelComponentTypeIterator instance to iterate over the ON_ModelComponent::Type values.
Rhino.DocObjects.MorphControlObject
Represents a MorphControl in a document.
Rhino.DocObjects.NamedViewWidgetObject
Rhino.DocObjects.ObjectAttributes
Attributes (color, material, layer,...) associated with a rhino object
Rhino.DocObjects.ObjectAttributes.ObjectFrameFlags
Rhino.DocObjects.ObjectColorSource
Defines enumerated values for the source of display color of single objects.
Rhino.DocObjects.ObjectDecoration
Defines bit mask values to represent object decorations.
Rhino.DocObjects.ObjectLinetypeSource
Defines enumerated values for the source of linetype of single objects.
Rhino.DocObjects.ObjectMaterialSource
Defines enumerated values for the source of material of single objects.

ObjectMode

Since v5.0
Rhino.DocObjects.ObjectMode
Defines enumerated values for the display and behavior of single objects.
Rhino.DocObjects.ObjectPlotColorSource
Defines enumerated values for the source of plotting/printing color of single objects.
Rhino.DocObjects.ObjectPlotWeightSource
Defines enumerated values for the source of plotting/printing weight of single objects.
Rhino.DocObjects.ObjectSectionAttributesSource
The source of sectioning attributes on an object.
Rhino.DocObjects.ObjectSectionFillRule
For sectioning an object; the decision of when to generate hatches and fills.

ObjectType

Since v5.0
Rhino.DocObjects.ObjectType
Defines binary mask values for each object type that can be found in a document.
Rhino.DocObjects.ObjRef
Represents a reference to a Rhino object.
Rhino.DocObjects.OrdinateDimensionObject
Rhino Object that represents an ordinate dimension geometry and attributes

PageSettings

Since v8.36
Rhino.DocObjects.PageSettings
The paper size and margins of a layout, in millimeters. Only meaningful for a view whose ViewInfo.ViewType is ViewType.PageView.

PageViewGroup

Since v9.0
Rhino.DocObjects.PageViewGroup
PageView Group class
Rhino.DocObjects.PhysicallyBasedMaterial
Rhino.DocObjects.PhysicallyBasedMaterial.BRDFs
Rhino.DocObjects.PointCloudObject
Rhino.DocObjects.PointObject
Rhino.DocObjects.ProxyObject
A proxy object (not saved in files)
Rhino.DocObjects.RadialDimensionObject
Rhino Object that represents a radial dimension geometry and attributes
Rhino.DocObjects.ReplayHistoryData
Provides history information to commands that will repeat history construction. Generally, a developer using this class will not construct a new instance, but receive one.
Rhino.DocObjects.ReplayHistoryResult
Rhino.DocObjects.RhinoAfterTransformObjectsEventArgs
EventArgs passed to RhinoDoc.AfterTransform.
Rhino.DocObjects.RhinoDeselectAllObjectsEventArgs
Rhino.DocObjects.RhinoModifyObjectAttributesEventArgs
Rhino.DocObjects.RhinoObject
Represents an object in the document.

RhinoObjects should only ever be creatable by the RhinoDoc.

Rhino.DocObjects.RhinoObject.ObjectFrameFlags
Rhino.DocObjects.RhinoObjectAnalysisModeChangedEventArgs
Rhino object visual analysis mode changed event argument.
Rhino.DocObjects.RhinoObjectEventArgs
Rhino.DocObjects.RhinoObjectSelectionEventArgs
Rhino.DocObjects.RhinoReplaceObjectEventArgs
Rhino.DocObjects.RhinoTransformObjectsEventArgs
EventArgs passed to RhinoDoc.BeforeTransform.
Rhino.DocObjects.SectionBackgroundFillMode
Defines how a background fill is applied to a section
Rhino.DocObjects.SectionLabelStyle
The source of sectioning attributes on an object.
Rhino.DocObjects.SectionStyle
SectionStyle helps define the attributes to use when drawing a section

SelectionMethod

Since v5.0
Rhino.DocObjects.SelectionMethod
Defines enumerated values for several kinds of selection methods.
Rhino.DocObjects.SubDObject
Rhino object for SubD
Rhino.DocObjects.SurfaceObject
Represents a surface in a document.
Rhino.DocObjects.TextDisplayAlignment
Defines enumerated values for the line alignment of text.
Rhino.DocObjects.TextDotObject
Represents a text dot that is a document.
Rhino.DocObjects.TextHorizontalAlignment
Horizontal location of text attach point relative to text
Rhino.DocObjects.TextObject
Rhino Object that represents text geometry and attributes
Rhino.DocObjects.TextOrientation
Method for getting rotation for drawing text
Rhino.DocObjects.Texture
Represents a texture that is mapped on objects.
Rhino.DocObjects.TextureCombineMode
Determines how this texture is combined with others in a material's texture list.

TextureFilter

Since v8.3
Rhino.DocObjects.TextureFilter
Determines how the color of the image pixel is calculated when the image pixel corresponds to multiple texture bitmap pixels.
Rhino.DocObjects.TextureProjectionModes
Enum describing how texture is projected onto geometry

TextureType

Since v5.6
Rhino.DocObjects.TextureType
The TextureType controls how the pixels in the bitmap are interpreted.
Rhino.DocObjects.TextureUvwWrapping
Defines Texture UVW wrapping modes
Rhino.DocObjects.TextVerticalAlignment
Vertical location of text attach point relative to text
Rhino.DocObjects.ViewInfo
Represents the name and orientation of a View (and named view).

views can be thought of as cameras.

Rhino.DocObjects.ViewInfoFocalBlurModes
The different focal blur modes of the ViewInfo
Rhino.DocObjects.ViewportInfo
Represents a viewing frustum.
Rhino.DocObjects.ViewSectionBehavior
Defines how views work with clipping planes.

ViewType

Since v8.36
Rhino.DocObjects.ViewType
What a view in a document's view table is: a model view, a layout page, a detail nested inside a layout, or one of Rhino's special editor views.
Rhino.DocObjects.Worksession
Manages a list of models that are being used as reference geometry.
Rhino.DocObjects.WorksessionModel
An immutable snapshot of one model in a worksession.

The values are copied when the snapshot is taken, so an instance stays usable (though it may go out of date) after the worksession changes. It holds no pointer into the document.