dtAnim::CharacterFileHandler Class Reference

Simple Xerces XML handler that will store the data read from a character definition .xml file. More...

#include <characterfilehandler.h>

List of all members.

Public Member Functions

CharacterFileHandler ()

~CharacterFileHandler ()

virtual void characters (const XMLCh *const chars, const unsigned int length)

virtual void endDocument ()

virtual void ignorableWhitespace (const XMLCh *const chars, const unsigned int length)

virtual void processingInstruction (const XMLCh *const target, const XMLCh *const data)

virtual void setDocumentLocator (const XERCES_CPP_NAMESPACE_QUALIFIER Locator *const locator)

virtual void startDocument ()

virtual void startElement (const XMLCh *const uri, const XMLCh *const localname, const XMLCh *const qname, const XERCES_CPP_NAMESPACE_QUALIFIER Attributes &attrs)

virtual void endElement (const XMLCh *const uri, const XMLCh *const localname, const XMLCh *const qname)

virtual void startPrefixMapping (const XMLCh *const prefix, const XMLCh *const uri)

virtual void endPrefixMapping (const XMLCh *const prefix)

virtual void skippedEntity (const XMLCh *const name)

Public Attributes

std::string mName

Character Data.

std::vector< AnimationStruct > mAnimations

Container of animation structs.

std::vector< MaterialStruct > mMaterials

Container of material structs.

std::vector< MeshStruct > mMeshes

Container of mesh structs.

std::string mShaderGroup

Shader information for hardware skinning. these value work with the shader manager.

std::string mShaderName

unsigned mShaderMaxBones

double mLODStartDistance

double mLODEndDistance

double mLODMaxVisibleDistance

bool mFoundLODOptions

std::vector
< AnimationChannelStruct > mAnimationChannels

The preconfigured playbable animations.

std::vector
< AnimationSequenceStruct > mAnimationSequences

The preconfigured playbable animations.

std::string mSkeletonFilename

The one skeleton filename.

Static Public Attributes

static const std::string CHARACTER_XML_LOGGER

static const std::string CHARACTER_ELEMENT

static const std::string ANIMATION_ELEMENT

static const std::string SKELETON_ELEMENT

static const std::string MESH_ELEMENT

static const std::string MATERIAL_ELEMENT

static const std::string CHANNEL_ELEMENT

static const std::string SEQUENCE_ELEMENT

static const std::string NAME_ELEMENT

static const std::string FILENAME_ELEMENT

static const std::string ANIMATION_NAME_ELEMENT

static const std::string START_DELAY_ELEMENT

static const std::string FADE_IN_ELEMENT

static const std::string FADE_OUT_ELEMENT

static const std::string SPEED_ELEMENT

static const std::string BASE_WEIGHT_ELEMENT

static const std::string MAX_DURATION_ELEMENT

static const std::string IS_LOOPING_ELEMENT

static const std::string IS_ACTION_ELEMENT

static const std::string CHILD_ELEMENT

static const std::string SKINNING_SHADER_ELEMENT

static const std::string SHADER_GROUP_ELEMENT

static const std::string SHADER_NAME_ELEMENT

static const std::string SHADER_MAX_BONES_ELEMENT

static const std::string LOD_ELEMENT

static const std::string LOD_START_DISTANCE_ELEMENT

static const std::string LOD_END_DISTANCE_ELEMENT

static const std::string MAX_VISIBLE_DISTANCE_ELEMENT

Classes

struct AnimatableStruct

struct AnimationChannelStruct

struct AnimationSequenceStruct

struct AnimationStruct

structure to contain all info related to an animation More...

struct MaterialStruct

struct MeshStruct

structure to contain all info related to a mesh More...

Detailed Description

Simple Xerces XML handler that will store the data read from a character definition .xml file.

into a series of containers of strings. Usage:

  dtUtil::XercesParser parse;
  dtAnim::CharacterHandler handler;
  parser.Parse(filename, handler);

  std::string skeletonFilename = handler.mSkeletonFilename;
  ...

   <character>
      <skeleton fileName="skel.csf" />
      <animation fileName="anim1.xaf" />
      <animation ...
      <mesh fileName="mesh1.cmf" />
      <mesh ...
      <material fileName="mat1.crf" />
      <material ...
           <animationChannel>
         <name>Run</name>
              <animationName>Run</animationName>
         <startDelay>0.0</startDelay>
         <fadeIn>0.0</fadeIn>
         <fadeOut>0.0</fadeOut>
         <speed>1.0</speed>
         <baseWeight>1.0</baseWeight>
         <maxDuration>0.0</maxDuration>
              <isAction>0</isAction>
         <isLooping>1</isLooping>
      </animationChannel>
   </character>

Constructor & Destructor Documentation

dtAnim::CharacterFileHandler::CharacterFileHandler ( )

dtAnim::CharacterFileHandler::~CharacterFileHandler ( )

Member Function Documentation

void dtAnim::CharacterFileHandler::characters	(	const XMLCh *const	chars,
		const unsigned int	length
	)			`[virtual]`

void dtAnim::CharacterFileHandler::endDocument ( ) [virtual]

virtual void dtAnim::CharacterFileHandler::ignorableWhitespace	(	const XMLCh *const	chars,
		const unsigned int	length
	)			`[inline, virtual]`

virtual void dtAnim::CharacterFileHandler::processingInstruction	(	const XMLCh *const	target,
		const XMLCh *const	data
	)			`[inline, virtual]`

virtual void dtAnim::CharacterFileHandler::setDocumentLocator ( const XERCES_CPP_NAMESPACE_QUALIFIER Locator *const locator ) [inline, virtual]

void dtAnim::CharacterFileHandler::startDocument ( ) [virtual]

void dtAnim::CharacterFileHandler::startElement	(	const XMLCh *const	uri,
		const XMLCh *const	localname,
		const XMLCh *const	qname,
		const XERCES_CPP_NAMESPACE_QUALIFIER Attributes &	attrs
	)			`[virtual]`

void dtAnim::CharacterFileHandler::endElement	(	const XMLCh *const	uri,
		const XMLCh *const	localname,
		const XMLCh *const	qname
	)			`[virtual]`

virtual void dtAnim::CharacterFileHandler::startPrefixMapping	(	const XMLCh *const	prefix,
		const XMLCh *const	uri
	)			`[inline, virtual]`

virtual void dtAnim::CharacterFileHandler::endPrefixMapping ( const XMLCh *const prefix ) [inline, virtual]

virtual void dtAnim::CharacterFileHandler::skippedEntity ( const XMLCh *const name ) [inline, virtual]

Member Data Documentation

const std::string dtAnim::CharacterFileHandler::CHARACTER_XML_LOGGER [static]

const std::string dtAnim::CharacterFileHandler::CHARACTER_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::ANIMATION_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::SKELETON_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::MESH_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::MATERIAL_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::CHANNEL_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::SEQUENCE_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::NAME_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::FILENAME_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::ANIMATION_NAME_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::START_DELAY_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::FADE_IN_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::FADE_OUT_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::SPEED_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::BASE_WEIGHT_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::MAX_DURATION_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::IS_LOOPING_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::IS_ACTION_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::CHILD_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::SKINNING_SHADER_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::SHADER_GROUP_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::SHADER_NAME_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::SHADER_MAX_BONES_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::LOD_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::LOD_START_DISTANCE_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::LOD_END_DISTANCE_ELEMENT [static]

const std::string dtAnim::CharacterFileHandler::MAX_VISIBLE_DISTANCE_ELEMENT [static]

std::string dtAnim::CharacterFileHandler::mName

Character Data.

The name of this animated entity

std::vector<AnimationStruct> dtAnim::CharacterFileHandler::mAnimations

Container of animation structs.

std::vector<MaterialStruct> dtAnim::CharacterFileHandler::mMaterials

Container of material structs.

std::vector<MeshStruct> dtAnim::CharacterFileHandler::mMeshes

Container of mesh structs.

std::string dtAnim::CharacterFileHandler::mShaderGroup

Shader information for hardware skinning. these value work with the shader manager.

std::string dtAnim::CharacterFileHandler::mShaderName

unsigned dtAnim::CharacterFileHandler::mShaderMaxBones

double dtAnim::CharacterFileHandler::mLODStartDistance

double dtAnim::CharacterFileHandler::mLODEndDistance

double dtAnim::CharacterFileHandler::mLODMaxVisibleDistance

bool dtAnim::CharacterFileHandler::mFoundLODOptions

std::vector<AnimationChannelStruct> dtAnim::CharacterFileHandler::mAnimationChannels

The preconfigured playbable animations.

std::vector<AnimationSequenceStruct> dtAnim::CharacterFileHandler::mAnimationSequences

The preconfigured playbable animations.

std::string dtAnim::CharacterFileHandler::mSkeletonFilename

The one skeleton filename.

2.0.0 generated 14 Feb 2008


Public Member Functions
	CharacterFileHandler ()
	~CharacterFileHandler ()
virtual void	characters (const XMLCh *const chars, const unsigned int length)
virtual void	endDocument ()
virtual void	ignorableWhitespace (const XMLCh *const chars, const unsigned int length)
virtual void	processingInstruction (const XMLCh const target, const XMLCh const data)
virtual void	setDocumentLocator (const XERCES_CPP_NAMESPACE_QUALIFIER Locator *const locator)
virtual void	startDocument ()
virtual void	startElement (const XMLCh const uri, const XMLCh const localname, const XMLCh *const qname, const XERCES_CPP_NAMESPACE_QUALIFIER Attributes &attrs)
virtual void	endElement (const XMLCh const uri, const XMLCh const localname, const XMLCh *const qname)
virtual void	startPrefixMapping (const XMLCh const prefix, const XMLCh const uri)
virtual void	endPrefixMapping (const XMLCh *const prefix)
virtual void	skippedEntity (const XMLCh *const name)
Public Attributes
std::string	mName
	Character Data.
std::vector< AnimationStruct >	mAnimations
	Container of animation structs.
std::vector< MaterialStruct >	mMaterials
	Container of material structs.
std::vector< MeshStruct >	mMeshes
	Container of mesh structs.
std::string	mShaderGroup
	Shader information for hardware skinning. these value work with the shader manager.
std::string	mShaderName
unsigned	mShaderMaxBones
double	mLODStartDistance
double	mLODEndDistance
double	mLODMaxVisibleDistance
bool	mFoundLODOptions
std::vector < AnimationChannelStruct >	mAnimationChannels
	The preconfigured playbable animations.
std::vector < AnimationSequenceStruct >	mAnimationSequences
	The preconfigured playbable animations.
std::string	mSkeletonFilename
	The one skeleton filename.
Static Public Attributes
static const std::string	CHARACTER_XML_LOGGER
static const std::string	CHARACTER_ELEMENT
static const std::string	ANIMATION_ELEMENT
static const std::string	SKELETON_ELEMENT
static const std::string	MESH_ELEMENT
static const std::string	MATERIAL_ELEMENT
static const std::string	CHANNEL_ELEMENT
static const std::string	SEQUENCE_ELEMENT
static const std::string	NAME_ELEMENT
static const std::string	FILENAME_ELEMENT
static const std::string	ANIMATION_NAME_ELEMENT
static const std::string	START_DELAY_ELEMENT
static const std::string	FADE_IN_ELEMENT
static const std::string	FADE_OUT_ELEMENT
static const std::string	SPEED_ELEMENT
static const std::string	BASE_WEIGHT_ELEMENT
static const std::string	MAX_DURATION_ELEMENT
static const std::string	IS_LOOPING_ELEMENT
static const std::string	IS_ACTION_ELEMENT
static const std::string	CHILD_ELEMENT
static const std::string	SKINNING_SHADER_ELEMENT
static const std::string	SHADER_GROUP_ELEMENT
static const std::string	SHADER_NAME_ELEMENT
static const std::string	SHADER_MAX_BONES_ELEMENT
static const std::string	LOD_ELEMENT
static const std::string	LOD_START_DISTANCE_ELEMENT
static const std::string	LOD_END_DISTANCE_ELEMENT
static const std::string	MAX_VISIBLE_DISTANCE_ELEMENT
Classes
struct	AnimatableStruct
struct	AnimationChannelStruct
struct	AnimationSequenceStruct
struct	AnimationStruct
	structure to contain all info related to an animation More...
struct	MaterialStruct
struct	MeshStruct
	structure to contain all info related to a mesh More...