SnapShotsClient
This is the abstract interface class for all Snapshot clients.
Inheritance Hierarchy
System.Object
Rhino.DocObjects.SnapShots.SnapShotsClient
Namespace: Rhino.DocObjects.SnapShots
Assembly: RhinoCommon (in RhinoCommon.dll)
Syntax
public abstract class SnapShotsClient : IDisposable
The SnapShotsClient type exposes the following members.
Constructors
Name
Description
Public Method
SnapShotsClient
SnapShotsClient constructor
Properties
Name
Description
Public Property
CppPointer
Public Property
SerialNumber
Methods
Name
Description
Public Method
AnimateDocument
Called for each frame. Starting at 0.0.
Public Method
AnimateObject
Called for each frame. Starting at 0.0.
Public Method
AnimationStart
Called once at the start of an animation.
Public Method
AnimationStop
Called once at the end of an animation.
Public Method
Static Member
ApplicationCategory
Predefined application category
Public Method
Category
The category of this client. Usually one of the above predefined categories like e.g object, rendering or application category
Public Method
ClientId
The unique id of this client.
Public Method
Dispose
SnapShotsClient Dispose
Public Method
Static Member
DocumentCategory
Predefined document category
Public Method
Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public Method
ExtendBoundingBoxForDocumentAnimation
Called once at the start of an animation. This can be used to extend the scene bounding box to avoid clipping.
Public Method
ExtendBoundingBoxForObjectAnimation
Called once at the start of an animation. This can be used to extend the scene bounding box to avoid clipping.
Protected Method
Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public Method
GetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public Method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Public Method
IsCurrentModelStateInAnySnapshot(RhinoDoc, BinaryArchiveReader, SimpleArrayBinaryArchiveReader, TextLog)
Called before restoring a snapshot. Warns the user if the current model state is not already saved.
Public Method
IsCurrentModelStateInAnySnapshot(RhinoDoc, RhinoObject, BinaryArchiveReader, SimpleArrayBinaryArchiveReader, TextLog)
Called before restoring a snapshot. Warns the user if the current model state is not already saved.
Public Method
Static Member
LayersCategory
Predefined layers category
Public Method
Static Member
LightsCategory
Predefined lights category
Protected Method
MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public Method
Name
The client’s name.
Public Method
Static Member
ObjectsCategory
Predefined objects category
Public Method
ObjectTransformNotification
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.
Public Method
PlugInId
The plug-in id that registers this client.
Public Method
PrepareForDocumentAnimation
Called once at the start of an animation.
Public Method
PrepareForObjectAnimation
Called once at the start of an animation.
Public Method
Static Member
RegisterSnapShotClient
Function used to register snapshots client
Public Method
Static Member
RenderingCategory
Predefined rendering category
Public Method
RestoreDocument
Called when the user restores a snapshot and SupportDocument() returns true.
Public Method
RestoreObject
Called when the user restores a snapshot and SupportsObjects() and SupportsObject(Rhino.DocObjects.RhinoObject doc_object) returns true.
Public Method
SaveDocument
Called when the user saves a snapshot and SupportDocument() returns true.
Public Method
SaveObject
Called when the user saves a snapshot and SupportsObjects() and SupportsObject(Rhino.DocObjects.RhinoObject doc_object) returns true.
Public Method
SnapshotRestored
Called after all clients restored their data.
Public Method
SupportsAnimation
Returns true if the client allows animation.
Public Method
SupportsDocument
Defines if the client supports document user data or not
Public Method
SupportsObject
Returns true if the client saves/restores object user data for the given object.
Public Method
SupportsObjects
Returns true if the client saves/restores object user data.
Public Method
ToString
Returns a string that represents the current object.
(Inherited from Object.)
Public Method
Static Member
ViewsCategory
Predefined views category