ReplayHistoryData

References
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
The document this record belongs to
public RhinoDoc Document { get; }

HistoryVersion

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

RecordId

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

Results

#Since v5.0
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.

public ReplayHistoryResult[] Results { get; }

Methods

AppendHistoryResult

#Since v8.0
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.
public ReplayHistoryResult AppendHistoryResult()

Dispose

#Since v5.0
public void Dispose()

GetRhinoObjRef

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

TryGetBool

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

TryGetColor

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

TryGetDouble

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

TryGetDoubles

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

TryGetGuid

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

TryGetGuids

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

TryGetInt

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

TryGetInts

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

TryGetPoint3d

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

TryGetPoint3dOnObject

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

TryGetString

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

TryGetTransform

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

TryGetVector3d

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

UpdateResultArray

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