Constructors
Properties
Methods
Called for each frame. Starting at 0.0.
public abstract bool AnimateDocument()
doc,
doc is the current document.
dPos,
dPos is the current frame. Starting at 0.0.
archive_start,
archive_start is a archive to the data of the starting position.
archive_stop
archive_stop is a archive to the data of the ending position.
Returns: true if successful, otherwise false.
Called for each frame. Starting at 0.0.
public abstract bool AnimateObject()
doc,
doc is the current document.
doc_object,
doc_obj is the current object.
ref Transform
transform,
transform is a transformation matrix. The matrix is set to identity the first time an object is associated with a snapshot. After that the matrix is updated when the object is transformed(scale, rotate etc.).
dPos,
dPos is the current frame. Starting at 0.0.
archive_start,
archive_start is a archive to the data of the starting position.
archive_stop
archive_stop is a archive to the data of the ending position.
Called once at the start of an animation.
Called once at the end of an animation.
Predefined application category
The category of this client. Usually one of the above predefined categories like e.g object, rendering or application category
The unique id of this client.
Returns: The unique id of this client.
Called once at the start of an animation. This can be used to extend the scene bounding box to avoid clipping.
public abstract void ExtendBoundingBoxForDocumentAnimation()
doc,
doc is the current document.
archive_start,
archive_start is a archive to the data of the starting position.
archive_stop,
archive_stop is a archive to the data of the ending position.
ref BoundingBox
bbox
bbox is the current scene bounding box.
Called once at the start of an animation. This can be used to extend the scene bounding box to avoid clipping.
public abstract void ExtendBoundingBoxForObjectAnimation()
doc,
doc is the current document.
doc_object,
doc_obj is the current object.
ref Transform
transform,
transform is a transformation matrix. The matrix is set to identity the first time an object is associated with a snapshot. After that the matrix is updated when the object is transformed(scale, rotate etc.).
archive_start,
archive_start is a archive to the data of the starting position.
archive_stop,
archive_stop is a archive to the data of the ending position.
ref BoundingBox
bbox
bbox is the current scene bounding box.
Called before restoring a snapshot. Warns the user if the current model state is not already saved.
public abstract bool IsCurrentModelStateInAnySnapshot()
doc,
doc is the current document.
archive,
archive is the current state of the model.
archive_array,
archive_array is a list of client data.
text_log = null
text_log is used to list the missing items that cannot be found in the current model.
Returns: return true if successful, otherwise false.
Called before restoring a snapshot. Warns the user if the current model state is not already saved.
public abstract bool IsCurrentModelStateInAnySnapshot()
doc,
doc is the current document.
doc_object,
doc_object is the current object.
archive,
archive is the current state of the model.
archive_array,
archive_array is a list of client data.
text_log = null
text_log is used to list the missing items that cannot be found in the current model.
Returns: return true if successful, otherwise false.
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 abstract bool ObjectTransformNotification()
doc,
doc is the current document.
doc_object,
doc_obj is the current object.
ref Transform
transform,
transform is a transformation matrix. The matrix is set to identity the first time an object is associated with a snapshot. After that the matrix is updated when the object is transformed(scale, rotate etc.).
archive
archive is a archive which can be used to update the stored data.
Returns: true if successful, otherwise false.
The plug-in id that registers this client.
Returns: The plug-in id that registers this client.
Called once at the start of an animation.
public abstract bool PrepareForDocumentAnimation()
doc,
doc is the current document.
archive_start,
archive_start is a archive to the data of the starting position.
archive_stop
archive_stop is a archive to the data of the ending position.
Returns: true if successful, otherwise
Called once at the start of an animation.
public abstract bool PrepareForObjectAnimation()
doc,
doc is the current document.
doc_object,
doc_obj is the current object.
ref Transform
transform,
transform is a transformation matrix. The matrix is set to identity the first time an object is associated with a snapshot. After that the matrix is updated when the object is transformed(scale, rotate etc.).
archive_start,
archive_start is a archive to the data of the starting position.
archive_stop
archive_stop is a archive to the data of the ending position.
Returns: true if successful, otherwise false.
Function used to register snapshots client
Called when the user restores a snapshot and SupportDocument() returns true.
public abstract bool RestoreDocument()
doc,
doc is the current document
archive
archive is the archive to read the data from
Returns: true if successful, otherwise false
Called when the user restores a snapshot and SupportsObjects() and SupportsObject(Rhino.DocObjects.RhinoObject doc_object) returns true.
public abstract bool RestoreObject()
doc,
doc is the current document.
doc_object,
doc_obj is the current object.
ref Transform
transform,
transform is a transformation matrix. The matrix is set to identity the first time an object is associated with a snapshot. After that the matrix is updated when the object is transformed(scale, rotate etc.).
archive
archive is the archive to read the data from.
Returns: true if successful, otherwise false.
Called when the user saves a snapshot and SupportDocument() returns true.
public abstract bool SaveDocument()
doc,
doc is the current document
archive
archive is the archive to write the data to
Returns: true if successful, otherwise false
Called when the user saves a snapshot and SupportsObjects() and SupportsObject(Rhino.DocObjects.RhinoObject doc_object) returns true.
public abstract bool SaveObject()
doc,
doc is the current document.
doc_object,
doc_obj is the current object.
ref Transform
transform,
transform is a transformation matrix. The matrix is set to identity the first time an object is associated with a snapshot. After that the matrix is updated when the object is transformed(scale, rotate etc.).
archive
archive is the archive to write the data to.
Returns: true if successful, otherwise false.
Called after all clients restored their data.
Returns true if the client allows animation.
Returns: true if the client allows animation.
Defines if the client supports document user data or not
Returns: true if the client saves/restores document user data.
Returns true if the client saves/restores object user data for the given object.
Returns: true if the client saves/restores object user data for the given object.
Returns true if the client saves/restores object user data.
Returns: true if the client saves/restores object user data.