HistoryRecord

References
public class HistoryRecord : IDisposable
Provides a single bundling of information to be passed to Rhino when setting up history for an object.
Remarks: To use this object, just pass it to a RhinoDoc.Add() method along with the needed geometry. Do not reuse this class for more than one history addition.

Constructors

HistoryRecord

#Since v5.0
public HistoryRecord(
command,
version
)

Finalizer

~HistoryRecord

#
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
~HistoryRecord()

Properties

CopyOnReplaceObject

#Since v6.0
When an object is replaced and the old object has a history record with this field set, the history record is copied and attached to the new object. That allows a descendant object to continue the history linkage after it is edited.
public bool CopyOnReplaceObject { get; set; }

Handle

#Since v5.0
Wrapped native C++ pointer to CRhinoHistory instance
public nint Handle { get; }

Methods

Dispose

#Since v5.0
Actively reclaims unmanaged resources that this instance uses.
public void Dispose()

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.
)

SetBool

#Since v5.0
public bool SetBool(
id,
value
)

SetBools

#Since v5.0
public bool SetBools(
id,
values
)

SetBrep

#Since v5.0
public bool SetBrep(
id,
value
)

SetColor

#Since v5.0
public bool SetColor(
id,
value
)

SetColors

#Since v5.0
public bool SetColors(
id,
values
)

SetCurve

#Since v5.0
public bool SetCurve(
id,
value
)

SetDouble

#Since v5.0
public bool SetDouble(
id,
value
)

SetDoubles

#Since v5.0
public bool SetDoubles()

SetGuid

#Since v5.0
public bool SetGuid(
id,
value
)

SetGuids

#Since v5.0
public bool SetGuids(
id,
values
)

SetHistoryVersion

#Since v6.0
Specifies a non-zero integer that identifies the version of this history record. The virtual ReplayHistory() functions can check this version to avoid replaying history using information created by earlier versions of the command.
public bool SetHistoryVersion(
historyVersion
Any non-zero integer. It is strongly suggested that something like YYYYMMDD be used.
)
True if successful.

SetInt

#Since v5.0
public bool SetInt(
id,
value
)

SetInts

#Since v5.0
public bool SetInts(
id,
values
)

SetMesh

#Since v5.0
public bool SetMesh(
id,
Mesh
value
)

SetObjRef

#Since v5.0
public bool SetObjRef(
id,
value
)

SetPoint3d

#Since v5.0
public bool SetPoint3d(
id,
value
)

SetPoint3dOnObject

#Since v5.0
public bool SetPoint3dOnObject(
id,
objref,
value
)

SetPoint3ds

#Since v5.0
public bool SetPoint3ds()

SetString

#Since v5.0
public bool SetString(
id,
value
)

SetStrings

#Since v5.0
public bool SetStrings()

SetSurface

#Since v5.0
public bool SetSurface(
id,
value
)

SetTransorm

#Since v5.0
public bool SetTransorm(
id,
value
)

SetVector3d

#Since v5.0
public bool SetVector3d(
id,
value
)

SetVector3ds

#Since v5.0
public bool SetVector3ds()