Class GorgonV3AnimationJsonCodec
A codec used to read/write animations as a JSON formatted string value.
Inherited Members
Namespace: Gorgon.IO
Assembly: Gorgon.IO.Gorgon2D.dll
Syntax
public class GorgonV3AnimationJsonCodec : GorgonAnimationCodecCommon, IGorgonAnimationCodec, IGorgonNamedObject
Constructors
| Edit this page View SourceGorgonV3AnimationJsonCodec(Gorgon2D)
Initializes a new instance of the GorgonV3AnimationJsonCodec class.
Declaration
public GorgonV3AnimationJsonCodec(Gorgon2D renderer)
Parameters
Type | Name | Description |
---|---|---|
Gorgon2D | renderer | The renderer used for resource handling. |
Exceptions
Type | Condition |
---|---|
ArgumentNullException | Thrown when the |
Properties
| Edit this page View SourceCanDecode
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 SourceCanEncode
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 SourceVersion
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 SourceFromJson(Gorgon2D, string)
Function to convert a JSON formatted string into a IGorgonAnimation object.
Declaration
public IGorgonAnimation FromJson(Gorgon2D renderer, string json)
Parameters
Type | Name | Description |
---|---|---|
Gorgon2D | renderer | The renderer for the animation. |
string | json | The JSON string containing the animation data. |
Returns
Type | Description |
---|---|
IGorgonAnimation | A new IGorgonAnimation. |
Exceptions
Type | Condition |
---|---|
ArgumentNullException | Thrown when the |
ArgumentEmptyException | Thrown when the |
GorgonException | Thrown if the JSON string does not contain animation data, or there is a version mismatch. |
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 SourceOnIsReadable(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 SourceOnReadFromStream(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 | 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
| Edit this page View SourceOnSaveToStream(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
Exceptions
Type | Condition |
---|---|
NotSupportedException | This operation is not supported. |