RhinoObject Class

Gets or sets the object attributes.

Gets or sets the component status of the model component.

Returns ModelGeometry.

Gets the name of a component that is deleted.

Indicates if this object has been disposed or the document it originally belonged to has been disposed.

Gets the document that owns this object.

Gets the underlying geometry for this object.

All rhino objects are composed of geometry and attributes.

Gets or sets the activation state of object default editing grips.

true if grips are turned on and at least one is selected.

Number of groups object belongs to.

True if the object has a dynamic transformation

Returns a value indicating whether the component has an ID.

Returns a value indicating whether the component has an Index.

Returns a value indicating whether the component has a Name.

Will be true if the object contains sub object meshes with materials that are different than the top level object.

Gets true if this class has any custom information attached to it through UserData.

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.

Returns a value indicating whether the component ID is already locked.

Gets or sets the model component index attribute.

Returns a value indicating whether the component Index is already locked.

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.

The component status itself can be locked. This returns an indication.

Some objects cannot be deleted, like grips on lights and annotation objects.

true if the object is deleted. Deleted objects are kept by the document for undo purposes. Call RhinoDoc.UndeleteObject to undelete an object.

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.

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.

true if the object is used as part of an instance definition.

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.

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.

Returns true if the object is a picture frame. A picture frame object is an object that displays a texture map in all views.

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.

Returns true if object is a closed solid, otherwise false.

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

Tests an object to see if it is valid.

A value identifying the model that manages this component.

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.

Returns a value indicating whether the component Name is already locked.

Gets the runtime serial number that will be assigned to the next Rhino Object that is created.

Gets the Rhino-based object type.

When a component is in a model for reference, this value identifies the reference model.

Gets the render material associated with this object or null if there is none. This does not pay attention to the material source and will not check parent objects or layers for a RenderMaterial.

Gets the objects runtime serial number.

List of custom information that is attached to this class.

Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use shareable set of information.

Gets the object visibility.

Resets the HasId property of the model component to false, if possible.

Resets the HasIndex property of the model component to false, if possible.

Resets the HasName property of the model component to false, if possible.

Moves changes made to this RhinoObject into the RhinoDoc.

Assigns a parent object and a sub-object index to this.

Gets the setting of the CopyOnReplace field in this object's history

Create meshes used to render and analyze surface and polysurface objects.

Returns the bounding box of custom render primitives for this object .

Increments the Cyclic Redundancy Check value by this instance.

Get a brief description of a object, including it's attributes and geometry.

Actively reclaims unmanaged resources that this instance uses.

For derived class implementers.

This method is called with argument true when class user calls Dispose(), while with argument false when the Garbage Collector invokes the finalizer, or Finalize() method.

You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true.

Also, you must call the base virtual method within your overriding method.

Constructs a deep (full) copy of the geometry.

Turns on/off the object's editing grips.

Used to turn analysis modes on and off.

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.

Determines whether the specified object is equal to the current object.

Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().

Get a Rhino object for a unique runtime serial number

Gets a list of currently enabled analysis modes for this object.

Called when Rhino wants the bounding box of this object. Viewpoert can be null. This is the default base class version that will go through to the C++ base class if it is called from the custom object

Query the object for the value of a given named custom render mesh parameter.

While an object is being dynamically transformed (dragged, rotated, ...), the current transformation can be retrieved and used for creating dynamic display.

Return list of fill surfaces if any for object and clipping plane.

Return list of fill surfaces if any for object and clipping plane. Fills are trimmed by clipping planes that did not generate them.

Return list of fill surfaces if any for object and clipping plane.

Returns grips for this object If grips are enabled. If grips are not enabled, returns null.

Allocates an array of group indices of length GroupCount. If GroupCount is 0, then this method returns null.

Serves as the default hash function.

Gets a list of all highlighted sub-objects.

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.

Get the Material associated with the sub object identified by componentIndex if the component index is set to ComponentIndex.Unset then the top level material is returned.

Get the Material associated with the sub object identified by componentIndex if the component index is set to ComponentIndex.Unset then the top level material is returned.

Get the Material associated with the sub object identified by componentIndex if the component index is set to ComponentIndex.Unset then the top level material is returned.

Get existing meshes used to render and analyze surface and polysurface objects.

Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.

Gets the RenderMaterial that this object uses based on it's attributes and the document that the object is associated with. If there is no RenderMaterial associated with this object then null is returned. If null is returned you should call GetMaterial to get the material used to render this object.

Gets the RenderMaterial associated with this object if there is one. If there is no RenderMaterial associated with this object then null is returned. If null is returned you should call GetMaterial to get the material used to render this object.

Gets the RenderMaterial associated with this object if there is one. If there is no RenderMaterial associated with this object then null is returned. If null is returned you should call GetMaterial to get the material used to render this object.

Gets the RenderMaterial associated with this object if there is one. If there is no RenderMaterial associated with this object then null is returned. If null is returned you should call GetMaterial to get the material used to render this object.

Gets the render meshes of some objects.

Gets the render meshes of some objects.

Returns the meshing parameters that this object uses for generating render meshes. If this object does not have per-object meshing parameters, then the document's meshing parameters are returned.

Returns the meshing parameters that this object uses for generating render meshes.

Build custom render mesh(es) for this object.

Build custom render mesh(es) for this object.

Get a list of all selected sub-objects.

Explodes the object into sub-objects. It is up to the caller to add the returned objects to the document.

Get a list of the texture mapping channel Id's associated with object.

Get objects texture mapping

Gets a world XY-plane aligned tight bounding box from a collection of Rhino objects.

Get tight bounding box of this Rhino object. The Rhino object is not modified.

Gets a plane aligned tight bounding box from a collection of Rhino objects.

Gets the Type of the current instance.

Returns true if the object will has a set of custom render primitives - ie, CustomRenderMeshes will return non-null.

Returns whether this object has a history record

Returns true if this object has a texture mapping form any source (pluginId)

Modifies the highlighting of the object.

Highlights a sub-object.

Gets the ids of the child Rhino objects of this object.

Gets the ids of the parent Rhino objects of this object.

Reports if any visual analysis mode is currently active for an object.

Reports if a visual analysis mode is currently active for an object.

Determine if this object is active in a particular viewport.

Check highlight state.

Returns true if the object is capable of having a mesh of the specified type

Reports if an object can be selected.

Reports if an object can be selected.

Check selection state.

Determines if a sub-object is highlighted.

Reports if a sub-object can be selected.

Check sub-object selection state.

Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.

Locks the component Id property.

Locks the component Index property.

Locks the component Name property.

Creates a shallow copy of the current Object.

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.

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.

Meshes Rhino objects.

Meshes Rhino objects.

Meshes Rhino objects.

Meshes Rhino objects.

For derived classes implementers.

Defines the necessary implementation to free the instance from being constant.

This call informs an object it is about to be added to the list of active objects in the document.

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.

Called when Rhino wants to draw this object

Called when this a new instance of this object is created and copied from an existing object

Called to determine if this object or some sub-portion of this object should be picked given a pick context.

Called when this object has been picked

Called when the selection state of this object has changed

Called when a space morph has been applied to the geometry. Currently this only works for CustomMeshObject instances

Is called when a non-constant operation first occurs.

Called when a transformation has been applied to the geometry

Returns a set of custom render primitives for this object.

Selects an object.

Selects an object.

Selects an object.

Reports if an object can be selected.

Reports if an object can be selected.

If this object has a history record, the CopyOnReplace field is set When an object is replaced in a document and the old object has a history record with this field set, the history record is copied and attached to the new object. That allows a descendant object to continue the history linkage after it is edited.

Set the named custom render mesh parameter value for this object.

For expert use only. Sets the history record that describes how this object was created. This information is used to update this object when Rhino history is enabled and an input object changes.

Sets the per-object meshing parameters for this object. When set, this object will use these meshing parameters when generating a render mesh, instead of those provided by the document.

Sets texture mapping and mapping object transform for a channel

Gets a localized short descriptive name of the object.

Gets a localized short descriptive name of the object, along with it's open/closed status.

Determines if custom render meshes will be built for a particular object.

Determines if custom render meshes will be built for a particular object.

Create a JSON string representation of this object

Returns the name of the model component type, and then its name and index.

If a Rhino object has been manipulated by Rhino's gumball, and the gumball is not in its default position, then the object's repositioned gumball frame is returned.

Get the bounding box for the custom render meshes associated with this object.

Get the bounding box for the custom render meshes associated with this object.

Removes highlighting from all sub-objects.

Removes selection from all sub-objects.