CommonObject Class

CommonObject Class

Base class for .NET classes that wrap C++ unmanaged Rhino classes.
Inheritance Hierarchy
SystemObject
  Rhino.RuntimeCommonObject
    More...

Namespace:  Rhino.Runtime
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
Copy
[SerializableAttribute]
public abstract class CommonObject : IDisposable, 
	ISerializable
<SerializableAttribute>
Public MustInherit Class CommonObject
	Implements IDisposable, ISerializable

The CommonObject type exposes the following members.

Constructors
  NameDescription
Protected methodCommonObject
Allows construction from inheriting classes.
Protected methodCommonObject(SerializationInfo, StreamingContext)
Protected constructor for internal use.
Top
Properties
  NameDescription
Public propertyDisposed
Indicates if this object has been disposed or the document it originally belonged to has been disposed.
Public propertyHasUserData
Gets true if this class has any custom information attached to it through UserData.
Public propertyIsDocumentControlled
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 propertyIsValid
Tests an object to see if it is valid.
Public propertyStatic memberPerformCorruptionTesting
Used to test ON_Object* pointers to see if they are a brep or mesh that is corrupt enough to crash Rhino.
Public propertyUserData
List of custom information that is attached to this class.
Public propertyUserDictionary
Dictionary of custom information attached to this class. The dictionary is actually user data provided as an easy to use sharable set of information.
Top
Methods
  NameDescription
Protected methodConstructConstObject
Assigns a parent object and a subobject index to this.
Public methodDispose
Actively reclaims unmanaged resources that this instance uses.
Protected methodDispose(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 methodEnsurePrivateCopy
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 methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
(Overrides ObjectFinalize.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetObjectData
Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsValidWithLog
Determines if an object is valid. Also provides a report on errors if this object happens not to be valid.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodNonConstOperation
For derived classes implementers.

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

Protected methodOnSwitchToNonConst
Is called when a non-const operation first occurs.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Version Information

Rhino for Mac

Supported in: 5.4

Rhino for Windows

Supported in: 6.14
See Also
Inheritance Hierarchy

T:Rhino.Runtime.CommonObject