UserDictionary

UserData
[Guid("171E831F-7FEF-40E2-9857-E5CCD39446F0")] public class UserDictionary : UserData
Defines the storage data class for a user dictionary.

Properties

Description

#Since v5.0
Gets the text "RhinoCommon UserDictionary".
public override string Description { get; }

Dictionary

#Since v5.0
Gets the dictionary that is associated with this class.

This dictionary is unique.

public ArchivableDictionary Dictionary { get; }

ShouldWrite

#Since v5.0
Writes this entity if the count is larger than 0.
public override bool ShouldWrite { get; }

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.
public Transform Transform { get; protected set; }
inherited fromUserData

Methods

Dispose

Actively reclaims unmanaged resources that this instance uses.
public void Dispose()
inherited fromUserData

Dispose

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.

protected virtual void Dispose(
disposing
true if the call comes from the Dispose() method; false if it comes from the Garbage Collector finalizer.
)
inherited fromUserData

OnDuplicate

#
Clones the user data.
protected override void OnDuplicate(
source
The source data.
)

OnTransform

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.
protected virtual void OnTransform(
transform
The transform being applied.
)
inherited fromUserData

Read

#
Is called to read this entity.
protected override bool Read(
archive
An archive.
)
Always returns true.
UserData.Read

Write

#
Is called to write this entity.
protected override bool Write(
archive
An archive.
)
Always returns true.
UserData.Write