AnimationProperties

References
public class AnimationProperties : IDisposable
Contains information used by the Animation Tools to create sun, season, turntable and fly through animations.

Constructors

AnimationProperties

#Since v6.11
public AnimationProperties()
Initializes a new instance of the AnimationProperties class.

AnimationProperties

#Since v6.11
public AnimationProperties(AnimationProperties source)
Initialize new instance of the AnimationProperties class.
Parameters:
source (AnimationProperties)If not null, settings are copied from source

Finalizer

~AnimationProperties

#
~AnimationProperties()
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().

Properties

AnimationName

#Since v6.11
public string AnimationName { get; set; }
Gets or sets the name of the animation sequence.

CameraPathId

#Since v6.11
public Guid CameraPathId { get; set; }
Gets or sets the object ID of the camera path.

CameraPoints

#Since v6.11
public Point3d[] CameraPoints { get; set; }
Gets or sets points of the camera path.

CaptureMethod

#Since v6.11
public string CaptureMethod { get; set; }
Gets or sets the capture method of the animation which is either preview or full.

CaptureType

#Since v6.11
[CLSCompliant(false)] public AnimationProperties.CaptureTypes CaptureType { get; set; }
Gets or sets the capture type of the animation.

CurrentFrame

#Since v7.12
public int CurrentFrame { get; set; }
Gets or sets the current frame during animation record.

Dates

#Since v6.11
public string[] Dates { get; set; }
Gets or sets the dates that are calculated for seasonal/one day sun animations.

DaysBetweenFrames

#Since v6.11
public int DaysBetweenFrames { get; set; }
Gets or sets the days between captured frames for seasonal sun animation.

DisplayMode

#Since v6.11
public Guid DisplayMode { get; set; }
Gets or sets the ID of the view display mode (wireframe, shaded...).

EndDay

#Since v6.11
public int EndDay { get; set; }
Gets or sets the end day for seasonal day sun animation in the range 1 to 31.

EndHour

#Since v6.11
public int EndHour { get; set; }
Gets or sets the end hour for one day sun animation in the range 0 to 23.

EndMinutes

#Since v6.11
public int EndMinutes { get; set; }
Gets or sets the end minutes for one day sun animation in the range 0 to 59.

EndMonth

#Since v6.11
public int EndMonth { get; set; }
Gets or sets the end month for seasonal day sun animation in the range 1 to 12.

EndSeconds

#Since v6.11
public int EndSeconds { get; set; }
Gets or sets the end seconds for one day sun animation in the range 0 to 59.

EndYear

#Since v6.11
public int EndYear { get; set; }
Gets or sets the end year for seasonal day sun animation in the range 1800 to 2199.

FileExtension

#Since v6.11
public string FileExtension { get; set; }
Gets or sets the file extension of the saved frames created by the animation.

FolderName

#Since v6.11
public string FolderName { get; set; }
Gets or sets the location for the saved frames.

FrameCount

#Since v6.11
public int FrameCount { get; set; }
Gets or sets the number of frames to be captured.

HtmlFileName

#Since v7.12
public string HtmlFileName { get; set; }
Gets or sets the HTML file name. This property is the same as AnimationName.

HtmlFullPath

#Since v7.12
public string HtmlFullPath { get; }
Return HTML file path consisting of FolderName and HtmlFileName. To change this set FolderName and HtmlFileName.

Images

#Since v6.11
public string[] Images { get; set; }
Gets or sets the full path to the saved frames of an animation.

Latitude

#Since v6.11
public double Latitude { get; set; }
Gets or sets the latitude for sun animations in the range of -90 to +90.

LightIndex

#Since v6.11
public int LightIndex { get; set; }
Internal value used while previewing animation.

Longitude

#Since v6.11
public double Longitude { get; set; }
Gets or sets the longitude for sun animations in the range of -180 to +180.

MinutesBetweenFrames

#Since v6.11
public int MinutesBetweenFrames { get; set; }
Gets or sets the minutes between captured frames for one day sun animation.

NorthAngle

#Since v6.11
public double NorthAngle { get; set; }
Gets or sets the world angle corresponding to North in degrees. This angle is zero along the x-axis and increases anticlockwise.

RenderFull

#Since v6.11
public bool RenderFull { get; set; }
Gets or sets a value indicating whether to capture a frame in rendered mode.

RenderPreview

#Since v6.11
public bool RenderPreview { get; set; }
Gets or sets a value indicating whether to capture a frame in preview rendered mode.

StartDay

#Since v6.11
public int StartDay { get; set; }
Gets or sets the start day for seasonal/one day sun animation in the range 1 to 31.

StartHour

#Since v6.11
public int StartHour { get; set; }
Gets or sets the start hour for seasonal/one day sun animation in the range 0 to 23.

StartMinutes

#Since v6.11
public int StartMinutes { get; set; }
Gets or sets the start minutes for seasonal/one day sun animation in the range 0 to 59.

StartMonth

#Since v6.11
public int StartMonth { get; set; }
Gets or sets the start month for seasonal/one day sun animation in the range 1 to 12.

StartSeconds

#Since v6.11
public int StartSeconds { get; set; }
Gets or sets the start seconds for seasonal/one day sun animation in the range 0 to 59.

StartYear

#Since v6.11
public int StartYear { get; set; }
Gets or sets the start year for seasonal/one day sun animation in the range 1800 to 2199.

TargetPathId

#Since v6.11
public Guid TargetPathId { get; set; }
Gets or sets the object ID of the target path.

TargetPoints

#Since v6.11
public Point3d[] TargetPoints { get; set; }
Gets or sets points of the target path.

ViewportName

#Since v6.11
public string ViewportName { get; set; }
Gets or sets the viewport that will be captured.

Methods

Dispose

#Since v6.11
public void Dispose()
Actively reclaims unmanaged resources that this instance uses.

Dispose

#
protected virtual void Dispose(bool disposing)
For derived class implementers.

This method is called with argument true when class user calls Dispose(), while with argument false when the Garbage Collector invokes the finalizer, or Finalize() method.

You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true.

Also, you must call the base virtual method within your overriding method.

Parameters:
disposing (bool)true if the call comes from the Dispose() method; false if it comes from the Garbage Collector finalizer.