Aurora::GFF3Struct Class Reference

A struct within a GFF3. More...

#include <gff3file.h>

Collaboration diagram for Aurora::GFF3Struct:

Classes
struct	Field
	A field in the GFF3 struct. More...

Public Types
enum	FieldType {   kFieldTypeNone = - 1, kFieldTypeByte = 0, kFieldTypeChar = 1, kFieldTypeUint16 = 2,   kFieldTypeSint16 = 3, kFieldTypeUint32 = 4, kFieldTypeSint32 = 5, kFieldTypeUint64 = 6,   kFieldTypeSint64 = 7, kFieldTypeFloat = 8, kFieldTypeDouble = 9, kFieldTypeExoString = 10,   kFieldTypeResRef = 11, kFieldTypeLocString = 12, kFieldTypeVoid = 13, kFieldTypeStruct = 14,   kFieldTypeList = 15, kFieldTypeOrientation = 16, kFieldTypeVector = 17, kFieldTypeStrRef = 18 }
	The type of a GFF3 field. More...

Public Member Functions
uint32	getID () const
	Return the struct's ID. More...
size_t	getFieldCount () const
	Return the number of fields in this struct. More...
bool	hasField (const Common::UString &field) const
	Does this specific field exist? More...
const std::vector< Common::UString > &	getFieldNames () const
	Return a list of all field names in this struct. More...
FieldType	getFieldType (const Common::UString &field) const
	Return the type of this field, or kFieldTypeNone if such a field doesn't exist. More...
char	getChar (const Common::UString &field, char def='\0') const
uint64	getUint (const Common::UString &field, uint64 def=0) const
int64	getSint (const Common::UString &field, int64 def=0) const
bool	getBool (const Common::UString &field, bool def=false) const
double	getDouble (const Common::UString &field, double def=0.0) const
Common::UString	getString (const Common::UString &field, const Common::UString &def="") const
bool	getLocString (const Common::UString &field, LocString &str) const
void	getVector (const Common::UString &field, float &x, float &y, float &z) const
void	getOrientation (const Common::UString &field, float &a, float &b, float &c, float &d) const
void	getVector (const Common::UString &field, double &x, double &y, double &z) const
void	getOrientation (const Common::UString &field, double &a, double &b, double &c, double &d) const
Common::SeekableReadStream *	getData (const Common::UString &field) const
const GFF3Struct &	getStruct (const Common::UString &field) const
const GFF3List &	getList (const Common::UString &field) const

Private Types
typedef std::map< Common::UString, Field >	FieldMap

Private Member Functions
	GFF3Struct (const GFF3File &parent, uint32 offset)
	~GFF3Struct ()
void	load (uint32 offset)
void	readField (Common::SeekableReadStream &data, uint32 index)
void	readFields (Common::SeekableReadStream &data, uint32 index, uint32 count)
void	readIndices (Common::SeekableReadStream &data, std::vector< uint32 > &indices, uint32 count) const
Common::UString	readLabel (Common::SeekableReadStream &data, uint32 index) const
const Field *	getField (const Common::UString &name) const
	Returns the field with this tag. More...
Common::SeekableReadStream &	getData (const Field &field) const
	Returns the extended field data for this field. More...

Private Attributes
const GFF3File *	_parent
	The parent GFF3. More...
uint32	_id
	The struct's ID. More...
uint32	_fieldIndex
	Field / Field indices index. More...
uint32	_fieldCount
	Field count. More...
FieldMap	_fields
	The fields, indexed by their label. More...
std::vector< Common::UString >	_fieldNames
	The names of all fields in this struct. More...

Friends
class	GFF3File
template<typename T >
void	Common::DeallocatorDefault::destroy (T *)

Detailed Description

A struct within a GFF3.

Definition at line 164 of file gff3file.h.

Member Typedef Documentation

FieldMap

typedef std::map<Common::UString, Field> Aurora::GFF3Struct::FieldMap

private

Definition at line 255 of file gff3file.h.

Member Enumeration Documentation

FieldType

enum Aurora::GFF3Struct::FieldType

The type of a GFF3 field.

Enumerator
kFieldTypeNone	Invalid type.
kFieldTypeByte	A single byte.
kFieldTypeChar	A single character.
kFieldTypeUint16	Unsigned 16bit integer.
kFieldTypeSint16	Signed 16bit integer.
kFieldTypeUint32	Unsigned 32bit integer.
kFieldTypeSint32	Signed 32bit integer.
kFieldTypeUint64	Unsigned 64bit integer.
kFieldTypeSint64	Signed 64bit integer.
kFieldTypeFloat	IEEE float.
kFieldTypeDouble	IEEE double.
kFieldTypeExoString	String.
kFieldTypeResRef	Resource reference, string.
kFieldTypeLocString	Localized string.
kFieldTypeVoid	Random data of variable length.
kFieldTypeStruct	Struct containing a number of fields.
kFieldTypeList	List containing a number of structs.
kFieldTypeOrientation	An object orientation.
kFieldTypeVector	A vector of 3 floats.
kFieldTypeStrRef	String reference, index into a talk table.

Definition at line 167 of file gff3file.h.

Constructor & Destructor Documentation

GFF3Struct()

Aurora::GFF3Struct::GFF3Struct ( const GFF3File &  parent, uint32  offset  )

private

Definition at line 304 of file gff3file.cpp.

References load().

Here is the call graph for this function:

~GFF3Struct()

Aurora::GFF3Struct::~GFF3Struct ( )

private

Definition at line 308 of file gff3file.cpp.

Member Function Documentation

getBool()

bool Aurora::GFF3Struct::getBool	(	const Common::UString &	field,
		bool	def = false
	)		const

Definition at line 510 of file gff3file.cpp.

References getUint().

Referenced by Engines::KotORJadeWidget::createBorder(), Engines::KotORJadeWidget::createText(), Engines::WidgetProgressbar::load(), Engines::WidgetListBox::load(), Engines::Witcher::Creature::load(), Engines::Jade::Waypoint::load(), Engines::DragonAge2::Waypoint::load(), Engines::DragonAge::Waypoint::load(), Aurora::DLGFile::load(), Engines::NWN2::Area::loadARE(), Engines::Jade::Trigger::loadBlueprint(), Engines::Jade::Creature::loadBlueprint(), Engines::Jade::Placeable::loadInstance(), Engines::Jade::Creature::loadInstance(), Engines::KotOR2::Placeable::loadObject(), Engines::NWN2::Placeable::loadObject(), Engines::Witcher::Placeable::loadObject(), Engines::KotOR::Placeable::loadObject(), Engines::NWN::Placeable::loadObject(), Engines::KotOR::Waypoint::loadProperties(), Engines::KotOR2::Waypoint::loadProperties(), Engines::NWN::Waypoint::loadProperties(), Engines::NWN2::Waypoint::loadProperties(), Engines::Witcher::Waypoint::loadProperties(), Engines::DragonAge::Placeable::loadProperties(), Engines::DragonAge2::Placeable::loadProperties(), Engines::Witcher::Situated::loadProperties(), Engines::NWN::Situated::loadProperties(), Engines::NWN2::Situated::loadProperties(), Engines::KotOR2::Situated::loadProperties(), Engines::KotOR::Situated::loadProperties(), Engines::KotOR2::Creature::loadProperties(), Engines::KotOR::Creature::loadProperties(), Engines::NWN2::Creature::loadProperties(), Engines::NWN::Creature::loadProperties(), and Engines::NWN::Area::loadTile().

Here is the call graph for this function:

Here is the caller graph for this function:

getChar()

char Aurora::GFF3Struct::getChar	(	const Common::UString &	field,
		char	def = '\0'
	)		const

Definition at line 426 of file gff3file.cpp.

References Aurora::GFF3Struct::Field::data, getField(), kFieldTypeChar, and Aurora::GFF3Struct::Field::type.

Here is the call graph for this function:

getData() [1/2]

Common::SeekableReadStream * Aurora::GFF3Struct::getData

(

const Common::UString &

field

)

const

Definition at line 638 of file gff3file.cpp.

References getField(), kFieldTypeExoString, kFieldTypeResRef, kFieldTypeVoid, Common::ReadStream::readByte(), Common::ReadStream::readStream(), Common::ReadStream::readUint32LE(), and Aurora::GFF3Struct::Field::type.

Referenced by getDouble(), getLocString(), getOrientation(), getSint(), getString(), getUint(), getVector(), and Aurora::IFOFile::load().

Here is the call graph for this function:

Here is the caller graph for this function:

getData() [2/2]

Common::SeekableReadStream & Aurora::GFF3Struct::getData ( const Field &  field ) const

private

Returns the extended field data for this field.

Definition at line 385 of file gff3file.cpp.

References _parent, Aurora::GFF3Struct::Field::data, Aurora::GFF3Struct::Field::extended, Aurora::GFF3File::getFieldData(), and Common::SeekableReadStream::skip().

Here is the call graph for this function:

getDouble()

double Aurora::GFF3Struct::getDouble	(	const Common::UString &	field,
		double	def = 0.0
	)		const

Definition at line 514 of file gff3file.cpp.

References convertIEEEFloat(), Aurora::GFF3Struct::Field::data, getData(), getField(), kFieldTypeDouble, kFieldTypeFloat, Common::ReadStream::readIEEEDoubleLE(), and Aurora::GFF3Struct::Field::type.

Referenced by Engines::KotOR::SavedGame::fillFromModuleIFO(), getString(), Engines::NWN::GUI::initCaption(), Engines::NWN::GUI::initWidget(), Engines::KotOR::Trigger::load(), Engines::KotORJadeWidget::load(), Engines::KotOR2::Trigger::load(), Engines::KotOR::Waypoint::load(), Engines::KotOR2::Waypoint::load(), Engines::NWN::Waypoint::load(), Engines::NWN2::Waypoint::load(), Engines::Witcher::Waypoint::load(), Engines::DragonAge2::Waypoint::load(), Engines::DragonAge::Waypoint::load(), Aurora::IFOFile::load(), Engines::NWN::Situated::load(), Engines::Witcher::Situated::load(), Engines::NWN2::Situated::load(), Engines::KotOR2::Situated::load(), Engines::KotOR::Situated::load(), Engines::KotOR2::Creature::load(), Engines::KotOR::Creature::load(), Engines::NWN2::Creature::load(), Engines::NWN::Creature::load(), Engines::KotOR::Area::loadARE(), Engines::DragonAge::Placeable::loadProperties(), Engines::DragonAge2::Placeable::loadProperties(), Engines::NWN2::Area::loadTile(), and Engines::KotOR::SoundObject::SoundObject().

Here is the call graph for this function:

Here is the caller graph for this function:

getField()

const GFF3Struct::Field * Aurora::GFF3Struct::getField ( const Common::UString &  name ) const

private

Returns the field with this tag.

Definition at line 418 of file gff3file.cpp.

References _fields.

Referenced by getChar(), getData(), getDouble(), getFieldType(), getList(), getLocString(), getOrientation(), getSint(), getString(), getStruct(), getUint(), getVector(), and hasField().

Here is the caller graph for this function:

getFieldCount()

size_t Aurora::GFF3Struct::getFieldCount

(

)

const

Return the number of fields in this struct.

Definition at line 396 of file gff3file.cpp.

References _fields.

getFieldNames()

const std::vector< Common::UString > & Aurora::GFF3Struct::getFieldNames

(

)

const

Return a list of all field names in this struct.

Definition at line 404 of file gff3file.cpp.

References _fieldNames.

getFieldType()

GFF3Struct::FieldType Aurora::GFF3Struct::getFieldType

(

const Common::UString &

field

)

const

Return the type of this field, or kFieldTypeNone if such a field doesn't exist.

Definition at line 408 of file gff3file.cpp.

References getField(), kFieldTypeNone, and Aurora::GFF3Struct::Field::type.

Here is the call graph for this function:

getID()

uint32 Aurora::GFF3Struct::getID

(

)

const

Return the struct's ID.

The ID is a (non-unique) number that's saved in the GFF3 file. It's sometimes used to identify the higher-level meaning of a struct within a GFF3.

The purpose of the ID in a GFF3 struct is comparable to the label in a GFF4 struct.

Definition at line 311 of file gff3file.cpp.

References _id.

getList()

const GFF3List & Aurora::GFF3Struct::getList

(

const Common::UString &

field

)

const

Definition at line 741 of file gff3file.cpp.

References _parent, Aurora::GFF3Struct::Field::data, getField(), Aurora::GFF3File::getList(), kFieldTypeList, and Aurora::GFF3Struct::Field::type.

Referenced by Engines::KotOR::SavedGame::fillFromModuleIFO(), Engines::KotOR2::Module::getName(), Engines::KotOR::Module::getName(), Engines::KotOR::Trigger::load(), Engines::KotOR2::Trigger::load(), Aurora::IFOFile::load(), Aurora::DLGFile::load(), Engines::NWN::Area::loadARE(), Engines::NWN2::Area::loadARE(), Engines::Witcher::Campaign::loadCampaignFile(), Engines::NWN2::Creature::loadClasses(), Engines::NWN::Creature::loadClasses(), Engines::NWN::Creature::loadEquippedItems(), Engines::Witcher::Area::loadGIT(), Engines::NWN::Area::loadGIT(), Engines::NWN2::Area::loadGIT(), Engines::KotOR2::Area::loadGIT(), Engines::KotOR::Area::loadGIT(), Engines::Jade::Trigger::loadInstance(), Engines::KotOR::Placeable::loadObject(), Engines::KotOR::Creature::loadProperties(), Engines::NWN2::Creature::loadProperties(), Engines::NWN::Creature::loadProperties(), Engines::Jade::Area::loadSAV(), Engines::NWN::GUI::loadWidget(), Engines::Jade::GUI::loadWidget(), Engines::KotOR::GUI::loadWidget(), Aurora::DLGFile::readEntry(), Engines::DragonAge::Object::readVarTable(), Engines::DragonAge2::Object::readVarTable(), and Engines::NWN2::Object::readVarTable().

Here is the call graph for this function:

Here is the caller graph for this function:

getLocString()

bool Aurora::GFF3Struct::getLocString	(	const Common::UString &	field,
		LocString &	str
	)		const

Definition at line 614 of file gff3file.cpp.

References getData(), getField(), kFieldTypeLocString, Common::SeekableReadStream::pos(), Aurora::LocString::readLocString(), Common::ReadStream::readUint32LE(), Aurora::LocString::swap(), and Aurora::GFF3Struct::Field::type.

Referenced by Engines::Witcher::Area::getName(), getString(), Engines::Witcher::Creature::load(), Engines::DragonAge::Waypoint::load(), Engines::DragonAge2::Waypoint::load(), Aurora::IFOFile::load(), Engines::Witcher::Area::loadARE(), Engines::Witcher::Campaign::loadCampaignFile(), Engines::Witcher::Waypoint::loadProperties(), Engines::DragonAge::Placeable::loadProperties(), Engines::DragonAge2::Placeable::loadProperties(), Engines::Witcher::Situated::loadProperties(), and Aurora::DLGFile::readEntry().

Here is the call graph for this function:

Here is the caller graph for this function:

getOrientation() [1/2]

void Aurora::GFF3Struct::getOrientation	(	const Common::UString &	field,
		float &	a,
		float &	b,
		float &	c,
		float &	d
	)		const

Definition at line 676 of file gff3file.cpp.

References getData(), getField(), kFieldTypeOrientation, Common::ReadStream::readIEEEFloatLE(), and Aurora::GFF3Struct::Field::type.

Referenced by getString().

Here is the call graph for this function:

Here is the caller graph for this function:

getOrientation() [2/2]

void Aurora::GFF3Struct::getOrientation	(	const Common::UString &	field,
		double &	a,
		double &	b,
		double &	c,
		double &	d
	)		const

Definition at line 709 of file gff3file.cpp.

References getData(), getField(), kFieldTypeOrientation, Common::ReadStream::readIEEEFloatLE(), and Aurora::GFF3Struct::Field::type.

Here is the call graph for this function:

getSint()

int64 Aurora::GFF3Struct::getSint	(	const Common::UString &	field,
		int64	def = 0
	)		const

Definition at line 473 of file gff3file.cpp.

References Aurora::GFF3Struct::Field::data, getData(), getField(), kFieldTypeByte, kFieldTypeChar, kFieldTypeSint16, kFieldTypeSint32, kFieldTypeSint64, kFieldTypeStrRef, kFieldTypeUint16, kFieldTypeUint32, kFieldTypeUint64, Common::ReadStream::readUint32LE(), Common::ReadStream::readUint64LE(), and Aurora::GFF3Struct::Field::type.

Referenced by Engines::KotORJadeWidget::createExtend(), getString(), Engines::WidgetProgressbar::load(), Engines::WidgetListBox::load(), Engines::KotOR::Item::load(), Engines::Jade::Waypoint::load(), Engines::DragonAge::Waypoint::load(), Engines::DragonAge2::Waypoint::load(), Aurora::IFOFile::load(), Engines::KotOR::Area::loadARE(), Engines::Jade::Creature::loadBlueprint(), Engines::Jade::Placeable::loadInstance(), Engines::KotOR::Placeable::loadObject(), Engines::KotOR::Creature::loadProperties(), Engines::NWN2::Creature::loadProperties(), Engines::NWN::Creature::loadProperties(), and Engines::Jade::Placeable::nextState().

Here is the call graph for this function:

Here is the caller graph for this function:

getString()

Common::UString Aurora::GFF3Struct::getString	(	const Common::UString &	field,
		const Common::UString &	def = ""
	)		const

Definition at line 527 of file gff3file.cpp.

References Common::composeString(), getData(), getDouble(), getField(), getLocString(), getOrientation(), getSint(), Aurora::LocString::getString(), getUint(), getVector(), Common::kEncodingASCII, kFieldTypeByte, kFieldTypeChar, kFieldTypeDouble, kFieldTypeExoString, kFieldTypeFloat, kFieldTypeLocString, kFieldTypeOrientation, kFieldTypeResRef, kFieldTypeSint16, kFieldTypeSint32, kFieldTypeSint64, kFieldTypeStrRef, kFieldTypeUint16, kFieldTypeUint32, kFieldTypeUint64, kFieldTypeVector, Common::ReadStream::readByte(), Common::readStringFixed(), Common::ReadStream::readUint32LE(), and Aurora::GFF3Struct::Field::type.

Referenced by Engines::KotORJadeWidget::createBorder(), Engines::KotORJadeWidget::createHilight(), Engines::WidgetListBox::createScrollbar(), Engines::KotORJadeWidget::createText(), Engines::KotOR::SavedGame::fillFromNFO(), Engines::Witcher::Campaign::getDescription(), Engines::NWN2::Module::getDescription(), Engines::Witcher::Module::getDescription(), Engines::Witcher::Campaign::getName(), Engines::NWN2::Module::getName(), Engines::Witcher::Module::getName(), Engines::KotOR2::Module::getName(), Engines::NWN2::Area::getName(), Engines::NWN::Area::getName(), Engines::KotOR::Module::getName(), Engines::NWN::Creature::getPCListInfo(), Engines::NWN::GUI::initCaption(), Engines::WidgetScrollbar::load(), Engines::WidgetCheckBox::load(), Engines::WidgetProgressbar::load(), Engines::KotOR::Trigger::load(), Engines::KotOR2::Trigger::load(), Engines::Witcher::Creature::load(), Engines::KotOR::Item::load(), Aurora::NFOFile::load(), Engines::Jade::Waypoint::load(), Engines::KotOR::Waypoint::load(), Engines::KotOR2::Waypoint::load(), Engines::NWN::Waypoint::load(), Engines::NWN2::Waypoint::load(), Engines::Witcher::Waypoint::load(), Engines::DragonAge::Placeable::load(), Engines::DragonAge2::Placeable::load(), Engines::DragonAge::Waypoint::load(), Engines::DragonAge2::Waypoint::load(), Aurora::IFOFile::load(), Engines::Jade::Placeable::load(), Engines::Jade::Trigger::load(), Engines::Jade::Creature::load(), Engines::Witcher::Door::load(), Engines::Witcher::Placeable::load(), Engines::KotOR2::Placeable::load(), Engines::NWN2::Placeable::load(), Engines::KotOR::Placeable::load(), Engines::NWN::Item::load(), Engines::NWN::Placeable::load(), Engines::KotOR::Door::load(), Engines::KotOR2::Door::load(), Engines::NWN2::Door::load(), Engines::NWN::Door::load(), Engines::KotOR2::Creature::load(), Aurora::DLGFile::load(), Engines::KotOR::Creature::load(), Engines::NWN2::Creature::load(), Engines::NWN::Creature::load(), Engines::Jade::Area::loadARE(), Engines::Witcher::Area::loadARE(), Engines::NWN::Area::loadARE(), Engines::NWN2::Area::loadARE(), Engines::KotOR2::Area::loadARE(), Engines::KotOR::Area::loadARE(), Engines::KotOR::Trigger::loadBlueprint(), Engines::KotOR2::Trigger::loadBlueprint(), Engines::Jade::Placeable::loadBlueprint(), Engines::Jade::Trigger::loadBlueprint(), Engines::Jade::Creature::loadBlueprint(), Engines::Witcher::Campaign::loadCampaignFile(), Engines::Jade::Placeable::loadInstance(), Engines::Jade::Trigger::loadInstance(), Engines::Witcher::Door::loadObject(), Engines::KotOR2::Door::loadObject(), Engines::KotOR::Door::loadObject(), Engines::NWN2::Door::loadObject(), Engines::KotOR::Placeable::loadObject(), Engines::NWN::Door::loadObject(), Engines::NWN::Situated::loadPortrait(), Engines::NWN::Item::loadPortrait(), Engines::KotOR2::Situated::loadPortrait(), Engines::KotOR::Situated::loadPortrait(), Engines::KotOR2::Creature::loadPortrait(), Engines::KotOR::Creature::loadPortrait(), Engines::NWN::Creature::loadPortrait(), Engines::NWN::Waypoint::loadProperties(), Engines::KotOR2::Waypoint::loadProperties(), Engines::NWN2::Waypoint::loadProperties(), Engines::KotOR::Waypoint::loadProperties(), Engines::Witcher::Waypoint::loadProperties(), Engines::DragonAge2::Placeable::loadProperties(), Engines::DragonAge::Placeable::loadProperties(), Engines::Witcher::Situated::loadProperties(), Engines::NWN::Situated::loadProperties(), Engines::NWN2::Situated::loadProperties(), Engines::NWN::Item::loadProperties(), Engines::KotOR2::Situated::loadProperties(), Engines::KotOR::Situated::loadProperties(), Engines::KotOR2::Creature::loadProperties(), Engines::KotOR::Creature::loadProperties(), Engines::NWN2::Creature::loadProperties(), Engines::NWN::Creature::loadProperties(), Engines::NWN::GUI::loadWidget(), Engines::Jade::Placeable::nextState(), Aurora::DLGFile::readEntry(), Aurora::DLGFile::readLink(), Engines::DragonAge2::ScriptContainer::readScript(), Engines::DragonAge::ScriptContainer::readScript(), Engines::Jade::ScriptContainer::readScripts(), Engines::Witcher::ScriptContainer::readScripts(), Engines::KotOR::ScriptContainer::readScripts(), Engines::NWN::ScriptContainer::readScripts(), Engines::NWN2::ScriptContainer::readScripts(), Engines::KotOR2::ScriptContainer::readScripts(), Engines::KotOR::SoundObject::SoundObject(), Engines::NWN::GUI::WidgetContext::WidgetContext(), Engines::KotOR::GUI::WidgetContext::WidgetContext(), and Engines::Jade::GUI::WidgetContext::WidgetContext().

Here is the call graph for this function:

getStruct()

const GFF3Struct & Aurora::GFF3Struct::getStruct

(

const Common::UString &

field

)

const

Definition at line 728 of file gff3file.cpp.

References _parent, Aurora::GFF3Struct::Field::data, getField(), Aurora::GFF3File::getStruct(), kFieldTypeStruct, and Aurora::GFF3Struct::Field::type.

Referenced by Engines::KotORJadeWidget::createBorder(), Engines::KotORJadeWidget::createExtend(), Engines::KotORJadeWidget::createHilight(), Engines::KotORJadeWidget::createText(), Engines::NWN::GUI::initCaption(), Engines::WidgetScrollbar::load(), Engines::WidgetCheckBox::load(), Engines::WidgetProgressbar::load(), Engines::WidgetListBox::load(), Engines::NWN2::Situated::load(), Engines::Witcher::Area::loadARE(), Engines::KotOR::Area::loadARE(), Engines::Jade::Creature::loadBlueprint(), Engines::NWN2::Area::loadGIT(), Engines::NWN::Area::loadGIT(), Engines::KotOR2::Area::loadGIT(), Engines::KotOR::Area::loadGIT(), Engines::Jade::Object::loadPositional(), Engines::NWN2::Creature::loadProperties(), Engines::Jade::Area::loadSAV(), Engines::NWN2::Area::loadTile(), Engines::Jade::Placeable::nextState(), Engines::Jade::ScriptContainer::readScripts(), and Engines::NWN2::readTint().

Here is the call graph for this function:

Here is the caller graph for this function:

getUint()

uint64 Aurora::GFF3Struct::getUint	(	const Common::UString &	field,
		uint64	def = 0
	)		const

Definition at line 436 of file gff3file.cpp.

References Aurora::GFF3Struct::Field::data, getData(), getField(), kFieldTypeByte, kFieldTypeChar, kFieldTypeSint16, kFieldTypeSint32, kFieldTypeSint64, kFieldTypeStrRef, kFieldTypeUint16, kFieldTypeUint32, kFieldTypeUint64, Common::ReadStream::readUint32LE(), Common::ReadStream::readUint64LE(), and Aurora::GFF3Struct::Field::type.

Referenced by Engines::KotORJadeWidget::createBorder(), Engines::KotORJadeWidget::createText(), Engines::KotOR::SavedGame::fillFromModuleIFO(), Engines::KotOR::SavedGame::fillFromNFO(), getBool(), getString(), Engines::NWN::GUI::initCaption(), Aurora::NFOFile::load(), Aurora::IFOFile::load(), Aurora::DLGFile::load(), Engines::NWN::Area::loadARE(), Engines::NWN2::Area::loadARE(), Engines::KotOR2::Area::loadARE(), Engines::KotOR::Area::loadARE(), Engines::NWN::Item::loadArmorParts(), Engines::Jade::Placeable::loadBlueprint(), Engines::Jade::Trigger::loadBlueprint(), Engines::NWN2::Creature::loadClasses(), Engines::NWN::Creature::loadClasses(), Engines::KotOR::Door::loadObject(), Engines::KotOR2::Door::loadObject(), Engines::Witcher::Door::loadObject(), Engines::NWN2::Door::loadObject(), Engines::KotOR2::Placeable::loadObject(), Engines::NWN2::Placeable::loadObject(), Engines::Witcher::Placeable::loadObject(), Engines::KotOR::Placeable::loadObject(), Engines::NWN::Door::loadObject(), Engines::NWN::Placeable::loadObject(), Engines::NWN::Situated::loadPortrait(), Engines::NWN::Item::loadPortrait(), Engines::KotOR2::Situated::loadPortrait(), Engines::KotOR::Situated::loadPortrait(), Engines::KotOR2::Creature::loadPortrait(), Engines::KotOR::Creature::loadPortrait(), Engines::NWN::Creature::loadPortrait(), Engines::DragonAge::Placeable::loadProperties(), Engines::DragonAge2::Placeable::loadProperties(), Engines::Witcher::Situated::loadProperties(), Engines::NWN::Situated::loadProperties(), Engines::NWN2::Situated::loadProperties(), Engines::NWN::Item::loadProperties(), Engines::KotOR2::Situated::loadProperties(), Engines::KotOR::Situated::loadProperties(), Engines::KotOR2::Creature::loadProperties(), Engines::Witcher::Area::loadProperties(), Engines::KotOR::Creature::loadProperties(), Engines::NWN2::Creature::loadProperties(), Engines::NWN2::Area::loadProperties(), Engines::NWN::Area::loadProperties(), Engines::KotOR2::Area::loadProperties(), Engines::KotOR::Area::loadProperties(), Engines::NWN::Creature::loadProperties(), Engines::NWN::Area::loadTile(), Engines::NWN2::Area::loadTile(), Aurora::DLGFile::readEntry(), Aurora::DLGFile::readLink(), Engines::NWN2::readTint(), Engines::NWN::GUI::WidgetContext::WidgetContext(), Engines::KotOR::GUI::WidgetContext::WidgetContext(), and Engines::Jade::GUI::WidgetContext::WidgetContext().

Here is the call graph for this function:

getVector() [1/2]

void Aurora::GFF3Struct::getVector	(	const Common::UString &	field,
		float &	x,
		float &	y,
		float &	z
	)		const

Definition at line 660 of file gff3file.cpp.

References getData(), getField(), kFieldTypeVector, Common::ReadStream::readIEEEFloatLE(), and Aurora::GFF3Struct::Field::type.

Referenced by Engines::KotORJadeWidget::createBorder(), Engines::KotORJadeWidget::createText(), getString(), Engines::KotORJadeWidget::load(), and Engines::Jade::Object::loadPositional().

Here is the call graph for this function:

Here is the caller graph for this function:

getVector() [2/2]

void Aurora::GFF3Struct::getVector	(	const Common::UString &	field,
		double &	x,
		double &	y,
		double &	z
	)		const

Definition at line 693 of file gff3file.cpp.

References getData(), getField(), kFieldTypeVector, Common::ReadStream::readIEEEFloatLE(), and Aurora::GFF3Struct::Field::type.

Here is the call graph for this function:

hasField()

bool Aurora::GFF3Struct::hasField

(

const Common::UString &

field

)

const

Does this specific field exist?

Definition at line 400 of file gff3file.cpp.

References getField().

Referenced by Engines::KotORJadeWidget::createBorder(), Engines::KotORJadeWidget::createExtend(), Engines::KotORJadeWidget::createHilight(), Engines::KotORJadeWidget::createText(), Engines::NWN::GUI::initCaption(), Engines::WidgetScrollbar::load(), Engines::WidgetProgressbar::load(), Engines::WidgetListBox::load(), Engines::Jade::Waypoint::load(), Aurora::IFOFile::load(), Engines::Witcher::Situated::load(), Engines::NWN2::Situated::load(), Engines::Witcher::Area::loadARE(), Engines::NWN2::Area::loadARE(), Engines::Jade::Creature::loadBlueprint(), Engines::NWN2::Creature::loadClasses(), Engines::NWN::Creature::loadClasses(), Engines::NWN::Creature::loadEquippedItems(), Engines::Witcher::Area::loadGIT(), Engines::NWN::Area::loadGIT(), Engines::NWN2::Area::loadGIT(), Engines::KotOR2::Area::loadGIT(), Engines::KotOR::Area::loadGIT(), Engines::KotOR::Placeable::loadObject(), Engines::DragonAge::Placeable::loadProperties(), Engines::DragonAge2::Placeable::loadProperties(), Engines::KotOR::Creature::loadProperties(), Engines::NWN2::Creature::loadProperties(), Engines::NWN::Creature::loadProperties(), Engines::Jade::Area::loadSAV(), Engines::NWN::GUI::loadWidget(), Engines::KotOR::GUI::loadWidget(), Engines::Jade::GUI::loadWidget(), Aurora::DLGFile::readEntry(), Engines::Jade::ScriptContainer::readScripts(), Engines::NWN2::readTint(), Engines::DragonAge::Object::readVarTable(), Engines::DragonAge2::Object::readVarTable(), and Engines::NWN2::Object::readVarTable().

Here is the call graph for this function:

Here is the caller graph for this function:

load()

void Aurora::GFF3Struct::load ( uint32  offset )

private

Definition at line 317 of file gff3file.cpp.

References _fieldCount, _fieldIndex, _id, _parent, Aurora::GFF3File::getStream(), readField(), readFields(), and Common::ReadStream::readUint32LE().

Referenced by GFF3Struct().

Here is the call graph for this function:

Here is the caller graph for this function:

readField()

void Aurora::GFF3Struct::readField ( Common::SeekableReadStream &  data, uint32  index  )

private

Definition at line 331 of file gff3file.cpp.

References _fieldNames, _fields, Aurora::GFF3File::_header, _parent, Aurora::GFF3File::Header::fieldCount, Aurora::GFF3File::Header::fieldOffset, readLabel(), Common::ReadStream::readUint32LE(), and Common::SeekableReadStream::seek().

Referenced by load(), and readFields().

Here is the call graph for this function:

Here is the caller graph for this function:

readFields()

void Aurora::GFF3Struct::readFields ( Common::SeekableReadStream &  data, uint32  index, uint32  count  )

private

Definition at line 354 of file gff3file.cpp.

References Aurora::GFF3File::_header, _parent, Aurora::GFF3File::Header::fieldIndicesCount, Aurora::GFF3File::Header::fieldIndicesOffset, readField(), readIndices(), and Common::SeekableReadStream::seek().

Referenced by load().

Here is the call graph for this function:

Here is the caller graph for this function:

readIndices()

void Aurora::GFF3Struct::readIndices ( Common::SeekableReadStream &  data, std::vector< uint32 > &  indices, uint32  count  ) const

private

Definition at line 372 of file gff3file.cpp.

References Common::ReadStream::readUint32LE().

Referenced by readFields().

Here is the call graph for this function:

Here is the caller graph for this function:

readLabel()

Common::UString Aurora::GFF3Struct::readLabel ( Common::SeekableReadStream &  data, uint32  index  ) const

private

Definition at line 379 of file gff3file.cpp.

References Aurora::GFF3File::_header, _parent, Common::kEncodingASCII, Aurora::GFF3File::Header::labelOffset, Common::readStringFixed(), and Common::SeekableReadStream::seek().

Referenced by readField().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

Common::DeallocatorDefault::destroy

template<typename T >

void Common::DeallocatorDefault::destroy ( T *  )

friend

GFF3File

friend class GFF3File

friend

Definition at line 291 of file gff3file.h.

Member Data Documentation

_fieldCount

uint32 Aurora::GFF3Struct::_fieldCount

private

Field count.

Definition at line 262 of file gff3file.h.

Referenced by load().

_fieldIndex

uint32 Aurora::GFF3Struct::_fieldIndex

private

Field / Field indices index.

Definition at line 261 of file gff3file.h.

Referenced by load().

_fieldNames

std::vector<Common::UString> Aurora::GFF3Struct::_fieldNames

private

The names of all fields in this struct.

Definition at line 267 of file gff3file.h.

Referenced by getFieldNames(), and readField().

_fields

FieldMap Aurora::GFF3Struct::_fields

private

The fields, indexed by their label.

Definition at line 264 of file gff3file.h.

Referenced by getField(), getFieldCount(), and readField().

_id

uint32 Aurora::GFF3Struct::_id

private

The struct's ID.

Definition at line 260 of file gff3file.h.

Referenced by getID(), and load().

_parent

const GFF3File* Aurora::GFF3Struct::_parent

private

The parent GFF3.

Definition at line 258 of file gff3file.h.

Referenced by getData(), getList(), getStruct(), load(), readField(), readFields(), and readLabel().

---

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

• src/aurora/gff3file.h
• src/aurora/gff3file.cpp