GAFConverter Class Reference

Inheritance diagram for GAFConverter:

Public Member Functions
	GAFConverter ()
	Initializes a new instance of the GAFConverter class. More...
	GAFConverter (string gafAnimationPath)
	Initializes a new instance of the GAFConverter class. More...
void	ProcessGAF ()
	Do parsing and fill data structures. More...
GAFElement	GetElementByName (string name, float scale)
	Gets the name of the element. More...
GAFAnimationConfigFrame[]	GetAnimationFramesByObject (string objectName)
	Gets the animation frames by object. More...
GAFAnimationConfigFrame[]	GetAnimationFramesByObjectSequence (string objectName, GAFAnimationSequence animationSequence)
	Gets the animation frames by object sequence. More...
override string	ToString ()
	Returns a System.String that represents the current GAFConverter. More...

Protected Member Functions
virtual void	OnFrameProcessed (FrameArgs e)
	Raises the frame changed event. More...
bool	IsPartExists (string partId)
	Determines whether this instance is part exists the specified partID. More...

Protected Attributes
string	mJASONString = ""
int	mFrameNumber = 0
string	mVersion
GAFTextureAtlas[]	mTextureAtlases
GAFAnimationSequence[]	mAnimationSequences
GAFAnimationObject[]	mAnimationObjects
GAFAnimationConfigFrame[]	mAnimationConfigFrames
GAFNamedPart[]	mNamedParts
GAFAnimationMask[]	mAnimationMasks
string	mGafAnimationPath
bool	mWasProcessed = false

Properties
GAFTextureAtlas[]	TextureAtlases [get]
	Gets the texture atlases. More...
GAFAnimationObject[]	AnimationObjects [get]
	Gets the animation objects. More...
GAFAnimationConfigFrame[]	AnimationConfigFrames [get]
	Gets the animation config frames. More...
GAFAnimationSequence[]	AnimationSequences [get]
	Gets the animation sequences. More...
GAFAnimationMask[]	AnimationMasks [get]
	Gets the animation masks. More...
GAFNamedPart[]	NamedParts [get]
	Gets the named parts. More...
int	FrameNumber [get]
	Gets the frame number. More...
string	Version [get]
	Gets the version. More...
bool	WasProcessed [get]
	Gets a value indicating whether this GAFConverter was processed. More...

Events
FrameHandler	FrameProcessed
	Occurs when frame processed. More...

Constructor & Destructor Documentation

GAFConverter.GAFConverter

(

)

Initializes a new instance of the GAFConverter class.

GAFConverter.GAFConverter

(

string

gafAnimationPath)

Initializes a new instance of the GAFConverter class.

Parameters

gafAnimationPath

Gaf animation path.

Member Function Documentation

GAFAnimationConfigFrame [] GAFConverter.GetAnimationFramesByObject

(

string

objectName)

Gets the animation frames by object.

Returns

The animation frames by object.

Parameters

objectName

Object name.

GAFAnimationConfigFrame [] GAFConverter.GetAnimationFramesByObjectSequence	(	string	objectName,
		GAFAnimationSequence	animationSequence
	)

Gets the animation frames by object sequence.

Returns

The animation frames by object sequence.

Parameters

objectName	Object name.
animationSequence	Animation sequence.

GAFElement GAFConverter.GetElementByName	(	string	name,
		float	scale
	)

Gets the name of the element.

Returns

The element by name.

Parameters

name	Name.
scale	Scale.

bool GAFConverter.IsPartExists ( string  partId)

protected

Determines whether this instance is part exists the specified partID.

Returns

true if this instance is part exists the specified partID; otherwise, false.

Parameters

partID

If set to true part I.

virtual void GAFConverter.OnFrameProcessed ( FrameArgs  e)

protectedvirtual

Raises the frame changed event.

Parameters

e

E.

void GAFConverter.ProcessGAF

(

)

Do parsing and fill data structures.

override string GAFConverter.ToString

(

)

Returns a System.String that represents the current GAFConverter.

Returns

A System.String that represents the current GAFConverter.

Member Data Documentation

GAFAnimationConfigFrame [] GAFConverter.mAnimationConfigFrames

protected

GAFAnimationMask [] GAFConverter.mAnimationMasks

protected

GAFAnimationObject [] GAFConverter.mAnimationObjects

protected

GAFAnimationSequence [] GAFConverter.mAnimationSequences

protected

int GAFConverter.mFrameNumber = 0

protected

string GAFConverter.mGafAnimationPath

protected

string GAFConverter.mJASONString = ""

protected

GAFNamedPart [] GAFConverter.mNamedParts

protected

GAFTextureAtlas [] GAFConverter.mTextureAtlases

protected

string GAFConverter.mVersion

protected

bool GAFConverter.mWasProcessed = false

protected

Property Documentation

GAFAnimationConfigFrame [] GAFConverter.AnimationConfigFrames

get

Gets the animation config frames.

The animation config frames.

GAFAnimationMask [] GAFConverter.AnimationMasks

get

Gets the animation masks.

The animation masks.

GAFAnimationObject [] GAFConverter.AnimationObjects

get

Gets the animation objects.

The animation objects.

GAFAnimationSequence [] GAFConverter.AnimationSequences

get

Gets the animation sequences.

The animation sequences.

int GAFConverter.FrameNumber

get

Gets the frame number.

The frame number.

GAFNamedPart [] GAFConverter.NamedParts

get

Gets the named parts.

The named parts.

GAFTextureAtlas [] GAFConverter.TextureAtlases

get

Gets the texture atlases.

The texture atlases.

string GAFConverter.Version

get

Gets the version.

The version.

bool GAFConverter.WasProcessed

get

Gets a value indicating whether this GAFConverter was processed.

true if was processed; otherwise, false.

Event Documentation

FrameHandler GAFConverter.FrameProcessed

Occurs when frame processed.

---

The documentation for this class was generated from the following file:

• D:/PROJECTS/UnityGAFPlayer/UnityGAFPlayer/Library/sfw2gaf_unity3d/Assets/Scripts/GAFConverter/Base/GAFConverter.cs