Class GorgonV3PolySpriteJsonCodec

A codec that can read and write a JSON formatted version of Gorgon v3 polygonal sprite data.

Inheritance

object

GorgonPolySpriteCodecCommon

GorgonV3PolySpriteJsonCodec

Implements

IGorgonPolySpriteCodec

IGorgonGraphicsObject

IGorgonNamedObject

Inherited Members

GorgonPolySpriteCodecCommon.CurrentFileHeader

GorgonPolySpriteCodecCommon.CurrentVersion

GorgonPolySpriteCodecCommon.CodecDescription

GorgonPolySpriteCodecCommon.Codec

GorgonPolySpriteCodecCommon.Renderer

GorgonPolySpriteCodecCommon.Graphics

GorgonPolySpriteCodecCommon.FileExtensions

GorgonPolySpriteCodecCommon.GetAssociatedTextureName(Stream)

GorgonPolySpriteCodecCommon.FromStream(Stream, GorgonTexture2DView, int?)

GorgonPolySpriteCodecCommon.FromFile(string, GorgonTexture2DView)

GorgonPolySpriteCodecCommon.Save(GorgonPolySprite, Stream)

GorgonPolySpriteCodecCommon.Save(GorgonPolySprite, string)

GorgonPolySpriteCodecCommon.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 GorgonV3PolySpriteJsonCodec : GorgonPolySpriteCodecCommon, IGorgonPolySpriteCodec, IGorgonGraphicsObject, IGorgonNamedObject

Constructors

GorgonV3PolySpriteJsonCodec(Gorgon2D)

Initializes a new instance of the GorgonV3PolySpriteJsonCodec class.

Declaration

public GorgonV3PolySpriteJsonCodec(Gorgon2D renderer)

Parameters

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

Exceptions

Type	Condition
ArgumentNullException	Thrown when the renderer parameter is null.

Properties

CanDecode

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

Declaration

public override bool CanDecode { get; }

Property Value

Type	Description
bool

Overrides

GorgonPolySpriteCodecCommon.CanDecode

CanEncode

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

Declaration

public override bool CanEncode { get; }

Property Value

Type	Description
bool

Overrides

GorgonPolySpriteCodecCommon.CanEncode

Version

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

Declaration

public override Version Version { get; }

Property Value

Type	Description
Version

Overrides

GorgonPolySpriteCodecCommon.Version

Methods

FromJson(Gorgon2D, GorgonTexture2DView, string)

Function to convert a JSON string into a sprite object.

Declaration

public static GorgonPolySprite FromJson(Gorgon2D renderer, GorgonTexture2DView overrideTexture, string json)

Parameters

Type	Name	Description
Gorgon2D	renderer	The renderer for the sprite.
GorgonTexture2DView	overrideTexture	The texture to assign to the sprite instead of the texture associated with the name stored in the file.
string	json	The JSON string containing the sprite data.

Returns

Type	Description
GorgonPolySprite	A new GorgonPolySprite.

Exceptions

Type	Condition
ArgumentNullException	Thrown when the renderer, or the json parameter is null.
ArgumentEmptyException	Thrown when the json parameter is empty.
GorgonException	Thrown if the JSON string does not contain sprite data, or there is a version mismatch.

OnGetAssociatedTextureName(Stream)

Function to retrieve the name of the associated texture.

Declaration

protected override string OnGetAssociatedTextureName(Stream stream)

Parameters

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

Returns

Type	Description
string	The name of the texture associated with the sprite, or null if no texture was found.

Overrides

GorgonPolySpriteCodecCommon.OnGetAssociatedTextureName(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

GorgonPolySpriteCodecCommon.OnIsReadable(Stream)

OnReadFromStream(Stream, int, GorgonTexture2DView)

Function to read the sprite data from a stream.

Declaration

protected override GorgonPolySprite OnReadFromStream(Stream stream, int byteCount, GorgonTexture2DView overrideTexture)

Parameters

Type	Name	Description
Stream	stream	The stream containing the sprite.
int	byteCount	The number of bytes to read from the stream.
GorgonTexture2DView	overrideTexture	The texture to assign to the sprite instead of the texture associated with the name stored in the file.

Returns

Type	Description
GorgonPolySprite	A new GorgonPolySprite.

Overrides

GorgonPolySpriteCodecCommon.OnReadFromStream(Stream, int, GorgonTexture2DView)

OnSaveToStream(GorgonPolySprite, Stream)

Function to save the sprite data to a stream.

Declaration

protected override void OnSaveToStream(GorgonPolySprite sprite, Stream stream)

Parameters

Type	Name	Description
GorgonPolySprite	sprite	The sprite to serialize into the stream.
Stream	stream	The stream that will contain the sprite.

Overrides

GorgonPolySpriteCodecCommon.OnSaveToStream(GorgonPolySprite, Stream)

Implements

IGorgonPolySpriteCodec

IGorgonGraphicsObject

IGorgonNamedObject

Extension Methods

GorgonDebugExtensions.ValidateObject<T>(T, string)

GorgonNullExtensions.AsNullable<T>(object)

GorgonNullExtensions.IfNull<T>(object, T)

GorgonNullExtensions.IsNull(object)