Class GorgonV3AnimationBinaryCodec

A codec used to read/write animations as binary formatted data.

Inheritance

object

GorgonAnimationCodecCommon

GorgonV3AnimationBinaryCodec

Implements

IGorgonAnimationCodec

IGorgonNamedObject

Inherited Members

GorgonAnimationCodecCommon.CurrentFileHeader

GorgonAnimationCodecCommon.CurrentVersion

GorgonAnimationCodecCommon.CodecDescription

GorgonAnimationCodecCommon.Codec

GorgonAnimationCodecCommon.Renderer

GorgonAnimationCodecCommon.Graphics

GorgonAnimationCodecCommon.FileExtensions

GorgonAnimationCodecCommon.GetAssociatedTextureNames(Stream)

GorgonAnimationCodecCommon.FromStream(Stream, int?, string, IEnumerable<GorgonTexture2DView>)

GorgonAnimationCodecCommon.FromFile(string, string, IEnumerable<GorgonTexture2DView>)

GorgonAnimationCodecCommon.Save(IGorgonAnimation, Stream)

GorgonAnimationCodecCommon.Save(IGorgonAnimation, string)

GorgonAnimationCodecCommon.IsReadable(Stream)

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Gorgon.IO

Assembly: Gorgon.IO.Gorgon2D.dll

Syntax

public class GorgonV3AnimationBinaryCodec : GorgonAnimationCodecCommon, IGorgonAnimationCodec, IGorgonNamedObject

Constructors

GorgonV3AnimationBinaryCodec(Gorgon2D)

Initializes a new instance of the GorgonV3AnimationBinaryCodec class.

Declaration

public GorgonV3AnimationBinaryCodec(Gorgon2D renderer)

Parameters

Type	Name	Description
Gorgon2D	renderer	The renderer used for resource handling.

Exceptions

Type	Condition
ArgumentNullException	Thrown when the renderer is null.

Fields

AnimationData

The animation track data chunk ID.

Declaration

public static readonly ulong AnimationData

Field Value

Type	Description
ulong

BoundsData

The bounds track data chunk ID.

Declaration

public static readonly ulong BoundsData

Field Value

Type	Description
ulong

ColorData

The color track data chunk ID.

Declaration

public static readonly ulong ColorData

Field Value

Type	Description
ulong

PositionData

The position track data chunk ID.

Declaration

public static readonly ulong PositionData

Field Value

Type	Description
ulong

RotationData

The rotation track data chunk ID.

Declaration

public static readonly ulong RotationData

Field Value

Type	Description
ulong

ScaleData

The scale track data chunk ID.

Declaration

public static readonly ulong ScaleData

Field Value

Type	Description
ulong

SizeData

The bounds track data chunk ID.

Declaration

public static readonly ulong SizeData

Field Value

Type	Description
ulong

TextureData

The texture track data chunk ID.

Declaration

public static readonly ulong TextureData

Field Value

Type	Description
ulong

VersionData

The version data chunk ID.

Declaration

public static readonly ulong VersionData

Field Value

Type	Description
ulong

Properties

CanDecode

Property to return whether or not the codec can decode animation data.

Declaration

public override bool CanDecode { get; }

Property Value

Type	Description
bool

Overrides

GorgonAnimationCodecCommon.CanDecode

CanEncode

Property to return whether or not the codec can encode animation data.

Declaration

public override bool CanEncode { get; }

Property Value

Type	Description
bool

Overrides

GorgonAnimationCodecCommon.CanEncode

Version

Property to return the version of animation data that the codec supports.

Declaration

public override Version Version { get; }

Property Value

Type	Description
Version

Overrides

GorgonAnimationCodecCommon.Version

Methods

OnGetAssociatedTextureNames(Stream)

Function to retrieve the names of the associated textures.

Declaration

protected override IReadOnlyList<string> OnGetAssociatedTextureNames(Stream stream)

Parameters

Type	Name	Description
Stream	stream	The stream containing the texture data.

Returns

Type	Description
IReadOnlyList<string>	The names of the texture associated with the animations, or an empty list if no textures were found.

Overrides

GorgonAnimationCodecCommon.OnGetAssociatedTextureNames(Stream)

OnIsReadable(Stream)

Function to determine if the data in a stream is readable by this codec.

Declaration

protected override bool OnIsReadable(Stream stream)

Parameters

Type	Name	Description
Stream	stream	The stream containing the data.

Returns

Type	Description
bool	true if the data can be read, or false if not.

Overrides

GorgonAnimationCodecCommon.OnIsReadable(Stream)

OnReadFromStream(string, Stream, int, IEnumerable<GorgonTexture2DView>)

Function to read the animation data from a stream.

Declaration

protected override IGorgonAnimation OnReadFromStream(string name, Stream stream, int byteCount, IEnumerable<GorgonTexture2DView> textureOverrides = null)

Parameters

Type	Name	Description
string	name	Not used.
Stream	stream	The stream containing the animation.
int	byteCount	The number of bytes to read from the stream.
IEnumerable<GorgonTexture2DView>	textureOverrides	[Optional] Textures to use in a texture animation track.

Returns

Type	Description
IGorgonAnimation	A new IGorgonAnimation.

Overrides

GorgonAnimationCodecCommon.OnReadFromStream(string, Stream, int, IEnumerable<GorgonTexture2DView>)

OnSaveToStream(IGorgonAnimation, Stream)

Function to save the animation data to a stream.

Declaration

protected override void OnSaveToStream(IGorgonAnimation animation, Stream stream)

Parameters

Type	Name	Description
IGorgonAnimation	animation	The animation to serialize into the stream.
Stream	stream	The stream that will contain the animation.

Overrides

GorgonAnimationCodecCommon.OnSaveToStream(IGorgonAnimation, Stream)

Exceptions

Type	Condition
NotSupportedException	This operation is not supported.

Implements

IGorgonAnimationCodec

IGorgonNamedObject

Extension Methods

GorgonDebugExtensions.ValidateObject<T>(T, string)

GorgonNullExtensions.AsNullable<T>(object)

GorgonNullExtensions.IfNull<T>(object, T)

GorgonNullExtensions.IsNull(object)