SnapShotsClient

SnapShotsClient class

This is the abstract interface class for all Snapshot clients.

Derived Classes:

Namespace: Rhino.DocObjects.SnapShots
SnapShotsClient: references

Constructors (1)

SnapShotsClient()

SnapShotsClient constructor

Properties (2)

CppPointer

SerialNumber

Methods (33)

AnimateDocument(RhinoDoc doc, double dPos, BinaryArchiveReader archive_start, BinaryArchiveReader archive_stop)

Called for each frame. Starting at 0.0.

AnimateObject(RhinoDoc doc,RhinoObject doc_object,Transform transform, double dPos, BinaryArchiveReader archive_start, BinaryArchiveReader archive_stop)

Called for each frame. Starting at 0.0.

AnimationStart(RhinoDoc doc, int iFrames)

Called once at the start of an animation.

AnimationStop(RhinoDoc doc)

Called once at the end of an animation.

ApplicationCategory()

Predefined application category

Category()

The category of this client. Usually one of the above predefined categories like e.g object, rendering or application category

ClientId()

The unique id of this client.

Dispose()

SnapShotsClient Dispose

DocumentCategory()

Predefined document category

ExtendBoundingBoxForDocumentAnimation(RhinoDoc doc, BinaryArchiveReader archive_start, BinaryArchiveReader archive_stop,BoundingBox bbox)

Called once at the start of an animation. This can be used to extend the scene bounding box to avoid clipping.

ExtendBoundingBoxForObjectAnimation(RhinoDoc doc,RhinoObject doc_object,Transform transform, BinaryArchiveReader archive_start, BinaryArchiveReader archive_stop,BoundingBox bbox)

Called once at the start of an animation. This can be used to extend the scene bounding box to avoid clipping.

IsCurrentModelStateInAnySnapshot(RhinoDoc doc, BinaryArchiveReader archive, SimpleArrayBinaryArchiveReader archive_array, TextLog text_log)

Called before restoring a snapshot. Warns the user if the current model state is not already saved.

IsCurrentModelStateInAnySnapshot(RhinoDoc doc,RhinoObject doc_object, BinaryArchiveReader archive, SimpleArrayBinaryArchiveReader archive_array, TextLog text_log)

Called before restoring a snapshot. Warns the user if the current model state is not already saved.

LayersCategory()

Predefined layers category

LightsCategory()

Predefined lights category

Name()

The client's name.

ObjectsCategory()

Predefined objects category

ObjectTransformNotification(RhinoDoc doc,RhinoObject doc_object,Transform transform, BinaryArchiveReader archive)

Called for every object that is associated with a snapshot and gets transformed in Rhino. This is getting called for each stored snapshot and gives the client the possibility to update the stored data.

PlugInId()

The plug-in id that registers this client.

PrepareForDocumentAnimation(RhinoDoc doc, BinaryArchiveReader archive_start, BinaryArchiveReader archive_stop)

Called once at the start of an animation.

PrepareForObjectAnimation(RhinoDoc doc,RhinoObject doc_object,Transform transform, BinaryArchiveReader archive_start, BinaryArchiveReader archive_stop)

Called once at the start of an animation.

RegisterSnapShotClient(SnapShotsClient client)

Function used to register snapshots client

RenderingCategory()

Predefined rendering category

RestoreDocument(RhinoDoc doc, BinaryArchiveReader archive)

Called when the user restores a snapshot and SupportDocument() returns true.

RestoreObject(RhinoDoc doc,RhinoObject doc_object,Transform transform, BinaryArchiveReader archive)

Called when the user restores a snapshot and SupportsObjects() and SupportsObject(Rhino.DocObjects.RhinoObject doc_object) returns true.

SaveDocument(RhinoDoc doc, BinaryArchiveWriter archive)

Called when the user saves a snapshot and SupportDocument() returns true.

SaveObject(RhinoDoc doc,RhinoObject doc_object,Transform transform, BinaryArchiveWriter archive)