UnknownUserData
UserDataRepresents user data with unknown origin.
Constructors
Properties
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
Dispose
public void Dispose()
Actively reclaims unmanaged resources that this instance uses.
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.
Parameters:
| disposing (bool) | true if the call comes from the Dispose() method; false if it comes from the Garbage Collector finalizer. |
OnDuplicate
Is called when the object is being duplicated.
Parameters:
| source (UserData) | 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.
Parameters:
| transform (Transform) | The transform being applied. |
Read
Reads the content of this data from a stream archive.
Parameters:
| archive (BinaryArchiveReader) | An archive. |
Returns: true if the data was successfully written. The default implementation always returns false.
Write
Writes the content of this data to a stream archive.
Parameters:
| archive (BinaryArchiveWriter) | An archive. |
Returns: true if the data was successfully written. The default implementation always returns false.