Click or drag to resize

UnknownUserData Class

Represents user data with unknown origin.
Inheritance Hierarchy

Namespace:  Rhino.DocObjects.Custom
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
public class UnknownUserData : UserData

The UnknownUserData type exposes the following members.

Constructors
  NameDescription
Public methodUnknownUserData
Constructs a new unknown data entity.
Top
Properties
  NameDescription
Public propertyDescription
Descriptive name of the user data.
(Inherited from UserData.)
Public propertyShouldWrite
If you want to save this user data in a 3dm file, override ShouldWrite and return true. If you do support serialization, you must also override the Read and Write functions.
(Inherited from UserData.)
Public propertyTransform
Updated if user data is attached to a piece of geometry that is transformed and the virtual OnTransform() is not overridden. If you override OnTransform() and want Transform to be updated, then call the base class OnTransform() in your override. The default constructor sets Transform to the identity.
(Inherited from UserData.)
Top
Methods
  NameDescription
Public methodDispose
Actively reclaims unmanaged resources that this instance uses.
(Inherited from UserData.)
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.

(Inherited from UserData.)
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().
(Inherited from UserData.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnDuplicate
Is called when the object is being duplicated.
(Inherited from UserData.)
Protected methodOnTransform
Is called when the object associated with this data is transformed. If you override this function, make sure to call the base class if you want the stored Transform to be updated.
(Inherited from UserData.)
Protected methodRead
Reads the content of this data from a stream archive.
(Inherited from UserData.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodWrite
Writes the content of this data to a stream archive.
(Inherited from UserData.)
Top
See Also