Skip to content

SnapShotsClient

Public Class

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 constructor


Properties

Name

Description


Public Property

Public Property

Methods

Name

Description


Public Method

Called for each frame. Starting at 0.0.


Public Method

Called for each frame. Starting at 0.0.


Public Method

Called once at the start of an animation.


Public Method

Called once at the end of an animation.


Public Method
Static Member

Predefined application category


Public Method

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


Public Method

The unique id of this client.


Public Method

SnapShotsClient Dispose


Public Method
Static Member

Predefined document category


Public Method

Equals

Determines whether the specified object is equal to the current object.

(Inherited from Object.)


Public Method

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


Public Method

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

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


Public Method

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


Public Method
Static Member

Predefined layers category


Public Method
Static Member

Predefined lights category


Protected Method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)


Public Method

The client’s name.


Public Method
Static Member

Predefined objects category


Public Method

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

The plug-in id that registers this client.


Public Method

Called once at the start of an animation.


Public Method

Called once at the start of an animation.


Public Method
Static Member

Function used to register snapshots client


Public Method
Static Member

Predefined rendering category


Public Method

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


Public Method

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


Public Method

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


Public Method

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


Public Method

Called after all clients restored their data.


Public Method

Returns true if the client allows animation.


Public Method

Defines if the client supports document user data or not


Public Method

Returns true if the client saves/restores object user data for the given object.


Public Method

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

Predefined views category