RhinoCommon documentation has a new look. The old site can still be found here.

/

Rhino.DocObjects.Custom

/

UserDictionary

UserDictionary class

Defines the storage data class for a Rhino.Collections.ArchivableDictionary .

Inheritence: Rhino.DocObjects.Custom.UserDataUserDictionary
Derived Classes:

Namespace: Rhino.DocObjects.Custom
UserDictionary: references

Constructors (2)

UserData()

Initializes a new instance of the UserData class

UserDictionary()

Initializes a new instance of the UserDictionary class

Properties (6)

Description

Gets the text "RhinoCommon UserDictionary".

Description

Descriptive name of the user data.

Dictionary

Gets the dictionary that is associated with this class.
This dictionary is unique.

ShouldWrite

Writes this entity if the count is larger than 0.

ShouldWrite

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.

Transform

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.

Methods (12)

Copy(CommonObject source,CommonObject destination)

Expert user tool that copies user data that has a positive CopyCount from the source object to a destination object. Generally speaking you don't need to use Copy(). Simply rely on things like the copy constructors to do the right thing.

Dispose()

Actively reclaims unmanaged resources that this instance uses.

Dispose(bool disposing)

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.

MoveUserDataFrom(CommonObject objectWithUserData)

Moves the user data from objectWithUserData to a temporary data storage identified by the return Guid. When MoveUserDataFrom returns, the objectWithUserData will not have any user data.

MoveUserDataTo(CommonObject objectToGetUserData,Guid id, bool append)

Moves the user data.
See for more information.

OnDuplicate(UserData source)

Clones the user data.

OnDuplicate(UserData source)

Is called when the object is being duplicated.

OnTransform(Transform transform)

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.

Read(BinaryArchiveReader archive)

Is called to read this entity.

Read(BinaryArchiveReader archive)

Reads the content of this data from a stream archive.

Write(BinaryArchiveWriter archive)

Is called to write this entity.

Write(BinaryArchiveWriter archive)

Writes the content of this data to a stream archive.

Nothing found