ReplayHistoryData

References
public class ReplayHistoryData : IDisposable
Provides history information to commands that will repeat history construction. Generally, a developer using this class will not construct a new instance, but receive one.

Properties

Document

#Since v5.0
public RhinoDoc Document { get; }
The document this record belongs to

HistoryVersion

#Since v5.0
public int HistoryVersion { get; }
ReplayHistory overrides check the version number to ensure the information saved in the history record is compatible with the current implementation of ReplayHistory

RecordId

#Since v5.0
public Guid RecordId { get; }
Each history record has a unique id that Rhino assigns when it adds the history record to the history record table

Results

#Since v5.0
public ReplayHistoryResult[] Results { get; }
Provides access to BOTH inputs and outputs of the replay history operation.

Use this property to then call an appropriate UpdateToX() method and make your custom history support work.

Methods

AppendHistoryResult

#Since v8.0
public ReplayHistoryResult AppendHistoryResult()
Create an empty history result and add it to the end of the Results array. Note that you should call Results again if you need them as the old Results array will be out of sync with this class.

Dispose

#Since v5.0
public void Dispose()

GetRhinoObjRef

#Since v5.0
public ObjRef GetRhinoObjRef(int id)
In ReplayHistory, use GetRhinoObjRef to convert the information in a history record into the ObjRef that has up to date RhinoObject pointers
Parameters:
id (int)HistoryRecord value id
Returns: ObjRef on success, null if not successful

TryGetBool

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

TryGetColor

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

TryGetDouble

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

TryGetDoubles

#Since v6.10
public bool TryGetDoubles(int id, out double[] values)
Parameters:
id (int)
values (out double[])

TryGetGuid

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

TryGetGuids

#Since v8.0
public bool TryGetGuids(int id, out Guid[] values)
Parameters:
id (int)
values (out Guid[])

TryGetInt

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

TryGetInts

#Since v9.0
public bool TryGetInts(int id, out int[] values)
Parameters:
id (int)
values (out int[])

TryGetPoint3d

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

TryGetPoint3dOnObject

#Since v6.0
public bool TryGetPoint3dOnObject(int id, out Point3d value)
Parameters:
id (int)
value (out Point3d)

TryGetString

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

TryGetTransform

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

TryGetVector3d

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

UpdateResultArray

#Since v8.0
public void UpdateResultArray(IEnumerable<ReplayHistoryResult> newResults)
Update the Results array with a different set of values. Null entries in the newResults will result in empty ReplayHistoryResult elements
Parameters:
newResults (IEnumerable<ReplayHistoryResult>)