Click or drag to resize

Rhino.DocObjects Namespace

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.

Classes
  ClassDescription
Public classAngularDimensionObject
Rhino Object that represents an angular dimension geometry and attributes
Public classAnnotationObjectBase
Base class for all annotation objects (text and dimensions)
Public classBitmapEntry
Rhino.DocObjects.Tables.BitmapTable entry
Public classBrepObject
Represents a brep in a document.
Public classCentermarkObject
Rhino Object that represents a centermark geometry and attributes
Public classClippingPlaneObject
Represents the object of a clipping plane, stored in the Rhino document and with attributes.
Public classConstructionPlane
Represents a contruction plane inside the document.

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

Public classCurveObject
A Rhino Object that represents curve geometry and attributes
Public classDetailViewObject
Public classDimensionObject
Rhino Object that represents dimension geometry and attributes
Public classDimensionStyle
Can also be considered an annotation style since it is used for more than just dimensions
Public classEarthAnchorPoint
Contains information about the model's position in latitude, longitude, and elevation for GIS mapping applications.
Public classExtrusionObject
Public classFont
Defines a format for text.
Public classGripObject
Public classGroup
Public classHatchObject
Public classHatchPattern
Public classHatchPatternDefaults
Public classHistoryRecord
Provides a single bundling of information to be passed to Rhino when setting up history for an object.
Public classInstanceDefinition
This is the same as InstanceDefinitionGeometry, but in a Rhino document.
Public classInstanceObject
Public classLayer
Public classLeaderObject
Rhino Object that represents leader geometry and attributes
Public classLightObject
Public classLinearDimensionObject
Rhino Object that represents a linear dimension geometry and attributes
Public classLinetype
Public classMaterial
Public classMaterialRef
Public classMaterialRefCreateParams
Options passed to MaterialRefs.Create
Public classMaterialRefs
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.
Public classMeshObject
Public classModelComponent
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.

Public classMorphControlObject
Represents a MorphControl in a document.
Public classObjectAttributes
Attributes (color, material, layer,...) associated with a rhino object
Public classCode exampleObjectEnumeratorSettings
Settings used for getting an enumerator of objects in a document See Rhino.Collections.ObjectTable.GetEnumerator()
Public classObjRef
Represents a reference to a Rhino object.
Public classOrdinateDimensionObject
Rhino Object that represents an ordinate dimension geometry and attributes
Public classPointCloudObject
Public classPointObject
Public classRadialDimensionObject
Rhino Object that represents a radial dimension geometry and attributes
Public classReplayHistoryData
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.
Public classReplayHistoryResult
Public classRhinoDeselectAllObjectsEventArgs
Public classRhinoModifyObjectAttributesEventArgs
Public classRhinoObject
Represents an object in the document.

RhinoObjects should only ever be creatable by the RhinoDoc.

Public classRhinoObjectEventArgs
Public classRhinoObjectSelectionEventArgs
Public classRhinoReplaceObjectEventArgs
Public classRhinoTransformObjectsEventArgs
EventArgs passed to RhinoDoc.BeforeTransform.
Public classSurfaceObject
Represents a surface in a document.
Public classTextDotObject
Represents a text dot that is a document.
Public classTextObject
Rhino Object that represents text geometry and attributes
Public classTexture
Represents a texture that is mapped on objects.
Public classViewInfo
Represents the name and orientation of a View (and named view).

views can be thought of as cameras.

Public classViewportInfo
Represents a viewing frustum.
Public classWorksession
Manages a list of models that are being used as reference geometry.
Enumerations
  EnumerationDescription
Public enumerationActiveSpace
Defines the current working space.
Public enumerationAngleDisplayMode
Defines enumerated values for the display of angles.
Public enumerationBasepointZero
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.

Public enumerationCoordinateSystem
Defines enumerated values for coordinate systems to use as references.
Public enumerationDimensionStyleAngleDisplayFormat
Display format for angles
Public enumerationDimensionStyleArrowType
Defines enumerated values for arrowhead shapes.
Public enumerationDimensionStyleCenterMarkStyle
Style for drawing centermark for Radial dimensions and Centermark objects
Public enumerationDimensionStyleField
Field identifiers used for file i/o and getting/setting values
Public enumerationDimensionStyleLeaderContentAngleStyle
Angle for text or other leader or dimension content
Public enumerationDimensionStyleLeaderCurveStyle
Type of leader curve
Public enumerationDimensionStyleLengthDisplay
Dimension display length unit system and style
Public enumerationDimensionStyleLengthDisplayFormat
Obsolete format for length display - use ON_DimStyle::DimensionLengthDisplay instead
Public enumerationDimensionStyleMaskType
Text mask drawn with background color or explicit color
Public enumerationDimensionStyleStackDisplayFormat
Format of stacked fractions
Public enumerationDimensionStyleTextLocation
The location of text in linear, angular, radial, and ordinate dimensions.
Public enumerationDimensionStyleToleranceDisplayFormat
Style of tolerance display for dimensions
Public enumerationDimensionStyleZeroSuppression
Marks leading and trailing zeros for removal.
Public enumerationDisplayMode
Defines enumerated values for display modes, such as wireframe or shaded.
Public enumerationDistanceDisplayMode
Defines enumerated values for the display of distances in US customary and Imperial units.
Public enumerationFontFontStretch
Horizontal expansion or contraction of font
Public enumerationFontFontStyle
Vertical angle of font Upright, Italic, or Oblique
Public enumerationFontFontWeight
Weight enum values Avoid casting these values to int. Use ON_Font::WindowsLogfontWeightFromWeight() or ON_Font::AppleWeightOfFontFromWeight() or add another converter.
Public enumerationHatchPatternFillType
Public enumerationInstanceDefinitionArchiveFileStatus
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.
Public enumerationInstanceDefinitionLayerStyle
A InstanceDefinitionUpdateType.Static or InstanceDefinitionUpdateType.LinkedAndEmbedded idef must have LayerStyle = Unset, a InstanceDefinitionUpdateType.Linked InstanceDefnition must have LayerStyle = Active or Reference
Public enumerationInstanceDefinitionUpdateType
The possible relationships between the instance definition geometry and the archive containing the original defition.
Public enumerationModelComponentType
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.
Public enumerationObjectColorSource
Defines enumerated values for the source of display color of single objects.
Public enumerationObjectDecoration
Defines bit mask values to represent object decorations.
Public enumerationObjectLinetypeSource
Defines enumerated values for the source of linetype of single objects.
Public enumerationObjectMaterialSource
Defines enumerated values for the source of material of single objects.
Public enumerationObjectMode
Defines enumerated values for the display and behavior of single objects.
Public enumerationObjectPlotColorSource
Defines enumerated values for the source of plotting/printing color of single objects.
Public enumerationObjectPlotWeightSource
Defines enumerated values for the source of plotting/printing weight of single objects.
Public enumerationObjectType
Defines binary mask values for each object type that can be found in a document.
Public enumerationSelectionMethod
Defines enumerated values for several kinds of selection methods.
Public enumerationTextDisplayAlignment
Defines enumerated values for the line alignment of text.
Public enumerationTextHorizontalAlignment
Horizontal location of text attach point relative to text
Public enumerationTextOrientation
Method for getting rotation for drawing text
Public enumerationTextureCombineMode
Determines how this texture is combined with others in a material's texture list.
Public enumerationTextureType
The TextureType controls how the pixels in the bitmap are interpreted.
Public enumerationTextureUvwWrapping
Defines Texture UVW wrapping modes
Public enumerationTextVerticalAlignment
Vertical location of text attach point relative to text
Public enumerationViewInfoFocalBlurModes
The different focal blur modes of the ViewInfo