CommonObject

Public Class

Base class for .NET classes that wrap C++ unmanaged Rhino classes.

Inheritance Hierarchy

System.Object
Rhino.Runtime.CommonObject

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

[SerializableAttribute]
public abstract class CommonObject : IDisposable,
  ISerializable

The CommonObject type exposes the following members.

Constructors

Name

Description

Protected Method

CommonObject.

Allows construction from inheriting classes.

Protected Method

CommonObject(SerializationInfo, StreamingContext)

Protected constructor for internal use.

Properties

Name

Description

Public Property

Disposed

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

Public Property

HasUserData

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

Public Property

IsDocumentControlled

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.

Public Property

IsValid

Tests an object to see if it is valid.

Public Property
Static Member

PerformCorruptionTesting

Used to test ON_Object* pointers to see if they are a brep or mesh that is corrupt enough to crash Rhino.

Public Property

UserData

List of custom information that is attached to this class.

Public Property

UserDictionary

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

Methods

Name

Description

Protected Method

ConstructConstObject

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

Public Method

Dispose.

Actively reclaims unmanaged resources that this instance uses.

Protected Method

Dispose(Boolean)

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.

Public Method

EnsurePrivateCopy

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.

Public Method

Equals

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

(Inherited from Object.)

Protected Method

Finalize

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

(Overrides Object.Finalize..)

Public Method
Static Member

FromBase64String

Create a CommonObject instance from a Base64 encoded string. This is typically the values used when passing common objects around as JSON data

Public Method
Static Member

FromJSON(Dictionary.String, String.)

Create a CommonObject instance from a JSON dictionary

Public Method
Static Member

FromJSON(String)

Create a CommonObject instance from a JSON string

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

Public Method

GetObjectData

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

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

Public Method

IsValidWithLog

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

Protected Method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

Protected Method

NonConstOperation

For derived classes implementers.

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

Protected Method

OnSwitchToNonConst

Is called when a non-constant operation first occurs.

Public Method

ToJSON

Create a JSON string representation of this object

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

Inheritance Hierarchy

System.Object
Rhino.Runtime.CommonObject
Rhino.DocObjects.Environment
Rhino.DocObjects.ModelComponent
Rhino.DocObjects.ObjectAttributes
Rhino.DocObjects.Texture
Rhino.DocObjects.ViewportInfo
Rhino.Geometry.BrepRegion
Rhino.Geometry.BrepRegionFaceSide
Rhino.Geometry.GeometryBase
Rhino.Render.CachedTextureCoordinates
Rhino.Render.RenderSettings