Class GorgonV31AnimationBinaryCodec

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

Inheritance
object
GorgonAnimationCodecCommon
GorgonV31AnimationBinaryCodec
Implements
Inherited Members
Namespace: Gorgon.IO
Assembly: Gorgon.IO.Gorgon2D.dll
Syntax
public class GorgonV31AnimationBinaryCodec : GorgonAnimationCodecCommon, IGorgonAnimationCodec, IGorgonNamedObject

Constructors

| Edit this page View Source

GorgonV31AnimationBinaryCodec(Gorgon2D)

Initializes a new instance of the GorgonV31AnimationBinaryCodec class.

Declaration
public GorgonV31AnimationBinaryCodec(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

| Edit this page View Source

AnimationData

The animation track data chunk ID.

Declaration
public static readonly ulong AnimationData
Field Value
Type Description
ulong
| Edit this page View Source

ColorData

The color track data chunk ID.

Declaration
public static readonly ulong ColorData
Field Value
Type Description
ulong
| Edit this page View Source

QuaternionData

The Quaternion tracks data chunk ID.

Declaration
public static readonly ulong QuaternionData
Field Value
Type Description
ulong
| Edit this page View Source

RectData

The rectangle track data chunk ID.

Declaration
public static readonly ulong RectData
Field Value
Type Description
ulong
| Edit this page View Source

SingleData

The single floating point value track data chunk ID.

Declaration
public static readonly ulong SingleData
Field Value
Type Description
ulong
| Edit this page View Source

TextureData

The texture track data chunk ID.

Declaration
public static readonly ulong TextureData
Field Value
Type Description
ulong
| Edit this page View Source

Vector2Data

The 2D vector tracks data chunk ID.

Declaration
public static readonly ulong Vector2Data
Field Value
Type Description
ulong
| Edit this page View Source

Vector3Data

The 3D vector tracks data chunk ID.

Declaration
public static readonly ulong Vector3Data
Field Value
Type Description
ulong
| Edit this page View Source

Vector4Data

The 4D vector tracks data chunk ID.

Declaration
public static readonly ulong Vector4Data
Field Value
Type Description
ulong
| Edit this page View Source

VersionData

The version data chunk ID.

Declaration
public static readonly ulong VersionData
Field Value
Type Description
ulong

Properties

| Edit this page View Source

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
| Edit this page View Source

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
| Edit this page View Source

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

Methods

| Edit this page View Source

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
| Edit this page View Source

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
| Edit this page View Source

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)
Parameters
Type Name Description
string name

The name of the animation.
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
Remarks

Implementors should handle the textureOverrides parameter by matching the textures by name, and, if the texture is not found in the override list, fall back to whatever scheme is used to retrieve the texture for codec.

| Edit this page View Source

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

Implements

Extension Methods