Click or drag to resize
RhinoObject Class
Represents an object in the document.

RhinoObjects should only ever be creatable by the RhinoDoc.

Inheritance Hierarchy
SystemObject
  Rhino.DocObjectsRhinoObject
    More...

Namespace: Rhino.DocObjects
Assembly: RhinoCommon (in RhinoCommon.dll) Version: 5.1.50000.0 (5.0.20693.0)
Syntax
public class RhinoObject

The RhinoObject type exposes the following members.

Properties
  NameDescription
Public propertyAttributes
Gets or sets the object attributes.
Public propertyDocument
Gets the document that owns this object.
Public propertyGeometry
Gets the underlying geometry for this object.

All rhino objects are composed of geometry and attributes.

Public propertyGripsOn
Gets or sets the activation state of object default editing grips.
Public propertyGripsSelected
true if grips are turned on and at least one is selected.
Public propertyGroupCount
Number of groups object belongs to.
Public propertyHasDynamicTransform
True if the object has a dynamic transformation
Public propertyId
Every object has a Guid (globally unique identifier, also known as UUID, or universally unique identifier). The default value is Guid.Empty.

When an object is added to a model, the value is checked. If the value is Guid.Empty, a new Guid is created. If the value is not null but it is already used by another object in the model, a new Guid is created. If the value is not Guid.Empty and it is not used by another object in the model, then that value persists. When an object is updated, by a move for example, the value of ObjectId persists.

This value is the same as the one returned by this.Attributes.ObjectId.

Public propertyIsDeletable
Some objects cannot be deleted, like grips on lights and annotation objects.
Public propertyIsDeleted
true if the object is deleted. Deleted objects are kept by the document for undo purposes. Call RhinoDoc.UndeleteObject to undelete an object.
Public propertyIsHidden
An object must be in one of three modes: normal, locked or hidden. If an object is in normal mode, then the object's layer controls visibility and selectability. If an object is locked, then the object's layer controls visibility by the object cannot be selected. If the object is hidden, it is not visible and it cannot be selected.
Public propertyIsInstanceDefinitionGeometry
true if the object is used as part of an instance definition.
Public propertyIsLocked
An object must be in one of three modes: normal, locked or hidden. If an object is in normal mode, then the object's layer controls visibility and selectability. If an object is locked, then the object's layer controls visibility by the object cannot be selected. If the object is hidden, it is not visible and it cannot be selected.
Public propertyIsNormal
An object must be in one of three modes: normal, locked or hidden. If an object is in normal mode, then the object's layer controls visibility and selectability. If an object is locked, then the object's layer controls visibility by the object cannot be selected. If the object is hidden, it is not visible and it cannot be selected.
Public propertyIsReference
Gets a value indicating if an object is a reference object. An object from a work session reference model is a reference object and cannot be modified. An object is a reference object if, and only if, it is on a reference layer.
Public propertyIsValid
Tests an object to see if its data members are correctly initialized.
Public propertyName
Rhino objects have optional text names. More than one object in a model can have the same name and some objects may have no name.
Public propertyStatic memberNextRuntimeSerialNumber
Gets the runtime serial number that will be assigned to the next Rhino Object that is created.
Public propertyObjectType
Gets the Rhino-based object type.
Public propertyRuntimeSerialNumber
Gets the objects runtime serial number.
Public propertyVisible
Gets the object visibility.
Top
Methods
  NameDescription
Public methodCode exampleCommitChanges
Moves changes made to this RhinoObject into the RhinoDoc.
Public methodCreateMeshes
Create meshes used to render and analyze surface and polysrf objects.
Public methodCode exampleDuplicateGeometry
Constructs a deep (full) copy of the geometry.
Public methodEnableCustomGrips
Turns on/off the object's editing grips.
Public methodEnableVisualAnalysisMode
Used to turn analysis modes on and off.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetActiveVisualAnalysisModes
Gets a list of currently enabled analysis modes for this object.
Public methodGetDynamicTransform
While an object is being dynamically tranformed (dragged, rotated, ...), the current transformation can be retrieved and used for creating dynamic display.
Public methodGetGrips
Returns grips for this object If grips are enabled. If grips are not enabled, returns null.
Public methodGetGroupList
Allocates an array of group indices of length GroupCount. If GroupCount is 0, then this method returns null.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetHighlightedSubObjects
Gets a list of all highlighted subobjects.
Public methodGetMaterial
Gets material that this object uses based on it's attributes and the document that the object is associated with. In the rare case that a document is not associated with this object, null will be returned.
Public methodGetMeshes
Get existing meshes used to render and analyze surface and polysrf objects.
Public methodStatic memberGetRenderMeshes
Gets the render meshes of some objects.
Public methodGetRenderMeshParameters
Meshing parameters that this object uses for generating render meshes. If the object's attributes do not have custom meshing parameters, then the document's meshing parameters are used.
Public methodGetSelectedSubObjects
Get a list of all selected sub-objects.
Public methodGetSubObjects
Gets an array of sub-objects.
Public methodGetTextureChannels
Get a list of the texture mapping channel Id's associated with object.
Public methodGetTextureMapping(Int32)
Public methodGetTextureMapping(Int32, Transform)
Get objects texture mapping
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHighlight
Modifies the highlighting of the object.
Public methodHighlightSubObject
Highlights a subobject.
Public methodInVisualAnalysisMode
Reports if any visual analysis mode is currently active for an object.
Public methodInVisualAnalysisMode(VisualAnalysisMode)
Reports if a visual analysis mode is currently active for an object.
Public methodIsActiveInViewport
Determine if this object is active in a particular viewport.
Public methodIsHighlighted
Check highlight state.
Public methodIsMeshable
Returns true if the object is capable of having a mesh of the specified type
Public methodIsSelectable
Reports if an object can be selected.
Public methodIsSelectable(Boolean, Boolean, Boolean, Boolean)
Reports if an object can be selected.
Public methodIsSelected
Check selection state.
Public methodIsSubObjectHighlighted
Determines if a subobject is highlighted.
Public methodIsSubObjectSelectable
Reports if a subobject can be selected.
Public methodIsSubObjectSelected
Check sub-object selection state.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMemoryEstimate
Computes an estimate of the number of bytes that this object is using in memory. Note that this is a runtime memory estimate and does not directly compare to the amount of space take up by the object when saved to a file.
Public methodMeshCount
RhinoObjects can have several different types of meshes and different numbers of meshes. A b-rep can have a render and an analysis mesh on each face. A mesh object has a single render mesh and no analysis mesh. Curve, point, and annotation objects have no meshes.
Public methodStatic memberMeshObjects(IEnumerableRhinoObject, MeshingParameters, Mesh, ObjectAttributes)
Mesh Rhino Objects
Public methodStatic memberMeshObjects(IEnumerableRhinoObject, MeshingParameters, Boolean, Mesh, ObjectAttributes)
Mesh Rhino Objects
Protected methodOnAddToDocument
This call informs an object it is about to be added to the list of active objects in the document.
Protected methodOnDeleteFromDocument
This call informs an object it is about to be deleted. Some objects, like clipping planes, need to do a little extra cleanup before they are deleted.
Protected methodOnDraw
Called when Rhino wants to draw this object
Protected methodOnDuplicate
Called when this a new instance of this object is created and copied from an existing object
Protected methodOnPick
Called to determine if this object or some sub-portion of this object should be picked given a pick context.
Protected methodOnPicked
Called when this object has been picked
Protected methodOnSelectionChanged
Called when the selection state of this object has changed
Protected methodOnSpaceMorph
Called when a space morph has been applied to the geometry. Currently this only works for CustomMeshObject instances
Protected methodOnTransform
Called when a transformation has been applied to the geometry
Public methodCode exampleSelect(Boolean)
Selects an object.
Public methodSelect(Boolean, Boolean)
Selects an object.
Public methodSelect(Boolean, Boolean, Boolean, Boolean, Boolean, Boolean)
Selects an object.
Public methodSelectSubObject
Reports if an object can be selected.
Public methodShortDescription
Gets a localized short descriptive name of the object.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUnhighlightAllSubObjects
Removes highlighting from all subobjects.
Public methodUnselectAllSubObjects
Removes selection from all subobjects.
Top
See Also
Inheritance Hierarchy
SystemObject
  Rhino.DocObjectsRhinoObject
    Rhino.DocObjectsAnnotationObjectBase
    Rhino.DocObjectsBrepObject
    Rhino.DocObjectsClippingPlaneObject
    Rhino.DocObjectsCurveObject
    Rhino.DocObjectsDetailViewObject
    Rhino.DocObjectsExtrusionObject
    Rhino.DocObjectsGripObject
    Rhino.DocObjectsHatchObject
    Rhino.DocObjectsInstanceObject
    Rhino.DocObjectsLightObject
    Rhino.DocObjectsMeshObject
    Rhino.DocObjectsMorphControlObject
    Rhino.DocObjectsPointCloudObject
    Rhino.DocObjectsPointObject
    Rhino.DocObjectsSurfaceObject
    Rhino.DocObjectsTextDotObject