AnimationProperties

References
Contains information used by the Animation Tools to create sun, season, turntable and fly through animations.

Constructors

AnimationProperties

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

AnimationProperties

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

Finalizer

~AnimationProperties

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

Properties

AnimationName

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

CameraPathId

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

CameraPoints

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

CaptureMethod

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

CaptureType

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

CurrentFrame

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

Dates

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

DaysBetweenFrames

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

DisplayMode

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

EndDay

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

EndHour

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

EndMinutes

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

EndMonth

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

EndSeconds

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

EndYear

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

FileExtension

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

FolderName

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

FrameCount

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

HtmlFileName

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

HtmlFullPath

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

Images

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

Latitude

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

LightIndex

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

Longitude

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

MinutesBetweenFrames

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

NorthAngle

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

RenderFull

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

RenderPreview

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

StartDay

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

StartHour

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

StartMinutes

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

StartMonth

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

StartSeconds

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

StartYear

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

TargetPathId

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

TargetPoints

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

ViewportName

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

Methods

Dispose

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

Dispose

#
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.

protected virtual void Dispose(
disposing
true if the call comes from the Dispose() method; false if it comes from the Garbage Collector finalizer.
)