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 command, int version)
Parameters:
command (Command)
version (int)

Finalizer

~HistoryRecord

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

Properties

CopyOnReplaceObject

#Since v6.0
public bool CopyOnReplaceObject { get; set; }
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.

Handle

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

Methods

Dispose

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

Dispose

#
protected virtual void 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.

Parameters:
disposing (bool)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(int id, bool value)
Parameters:
id (int)
value (bool)

SetBools

#Since v5.0
public bool SetBools(int id, IEnumerable<bool> values)
Parameters:
id (int)
values (IEnumerable<bool>)

SetBrep

#Since v5.0
public bool SetBrep(int id, Brep value)
Parameters:
id (int)
value (Brep)

SetColor

#Since v5.0
public bool SetColor(int id, Color value)
Parameters:
id (int)
value (Color)

SetColors

#Since v5.0
public bool SetColors(int id, IEnumerable<Color> values)
Parameters:
id (int)
values (IEnumerable<Color>)

SetCurve

#Since v5.0
public bool SetCurve(int id, Curve value)
Parameters:
id (int)
value (Curve)

SetDouble

#Since v5.0
public bool SetDouble(int id, double value)
Parameters:
id (int)
value (double)

SetDoubles

#Since v5.0
public bool SetDoubles(int id, IEnumerable<double> values)
Parameters:
id (int)
values (IEnumerable<double>)

SetGuid

#Since v5.0
public bool SetGuid(int id, Guid value)
Parameters:
id (int)
value (Guid)

SetGuids

#Since v5.0
public bool SetGuids(int id, IEnumerable<Guid> values)
Parameters:
id (int)
values (IEnumerable<Guid>)

SetHistoryVersion

#Since v6.0
public bool SetHistoryVersion(int historyVersion)
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.
Parameters:
historyVersion (int)Any non-zero integer. It is strongly suggested that something like YYYYMMDD be used.
Returns: True if successful.

SetInt

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

SetInts

#Since v5.0
public bool SetInts(int id, IEnumerable<int> values)
Parameters:
id (int)
values (IEnumerable<int>)

SetMesh

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

SetObjRef

#Since v5.0
public bool SetObjRef(int id, ObjRef value)
Parameters:
id (int)
value (ObjRef)

SetPoint3d

#Since v5.0
public bool SetPoint3d(int id, Point3d value)
Parameters:
id (int)
value (Point3d)

SetPoint3dOnObject

#Since v5.0
public bool SetPoint3dOnObject(int id, ObjRef objref, Point3d value)
Parameters:
id (int)
objref (ObjRef)
value (Point3d)

SetPoint3ds

#Since v5.0
public bool SetPoint3ds(int id, IEnumerable<Point3d> values)
Parameters:
id (int)
values (IEnumerable<Point3d>)

SetString

#Since v5.0
public bool SetString(int id, string value)
Parameters:
id (int)
value (string)

SetStrings

#Since v5.0
public bool SetStrings(int id, IEnumerable<string> values)
Parameters:
id (int)
values (IEnumerable<string>)

SetSurface

#Since v5.0
public bool SetSurface(int id, Surface value)
Parameters:
id (int)
value (Surface)

SetTransorm

#Since v5.0
public bool SetTransorm(int id, Transform value)
Parameters:
id (int)
value (Transform)

SetVector3d

#Since v5.0
public bool SetVector3d(int id, Vector3d value)
Parameters:
id (int)
value (Vector3d)

SetVector3ds

#Since v5.0
public bool SetVector3ds(int id, IEnumerable<Vector3d> values)
Parameters:
id (int)
values (IEnumerable<Vector3d>)