DWFToolkit::DWFCoordinateSystem Class Reference
[DWF Package API]

#include "dwf/package/CoordinateSystem.h"

Inheritance diagram for DWFToolkit::DWFCoordinateSystem:

Inheritance graph
[legend]
Collaboration diagram for DWFToolkit::DWFCoordinateSystem:

Collaboration graph
[legend]
List of all members.

Detailed Description

This class contains Coordinate System definitions.

Since:
7.3

Definition at line 47 of file CoordinateSystem.h.

Public Types

typedef DWFOrderedVector<
DWFCoordinateSystem * > 
tList
 This type defines a list of DWFCoordinateSystem pointers.
enum  teType
 Enumeration values that define the use of the coordinate system.

Public Member Functions

_DWFTK_API DWFCoordinateSystem () throw ()
_DWFTK_API DWFCoordinateSystem (teType eType, const double *anOrigin, const double *anRotation, const DWFString &zName=L"", const DWFString &zID=L"") throw ()
_DWFTK_API DWFCoordinateSystem (const DWFCoordinateSystem &rCoordinateSystem) throw ()
_DWFTK_API DWFCoordinateSystemoperator= (const DWFCoordinateSystem &rCoordinateSystem) throw ()
virtual _DWFTK_API ~DWFCoordinateSystem () throw ()
_DWFTK_API void set (teType eType, const double *anOrigin, const double *anRotation, const DWFString &zName=L"", const DWFString &zID=L"") throw ()
_DWFTK_API const double * getOrigin () const throw ()
_DWFTK_API const double * getRotation () const throw ()
_DWFTK_API const DWFStringgetName () const throw ()
_DWFTK_API const DWFStringgetID () const throw ()
_DWFTK_API teType getType () const throw ()
virtual _DWFTK_API void parseAttributeList (const char **ppAttributeList) throw ( DWFException )
_DWFTK_API void serializeXML (DWFXMLSerializer &rSerializer, unsigned int nFlags) throw ( DWFException )


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFCoordinateSystem::DWFCoordinateSystem  )  throw ()
 

Constructor

Exceptions:
None 

_DWFTK_API DWFToolkit::DWFCoordinateSystem::DWFCoordinateSystem teType  eType,
const double *  anOrigin,
const double *  anRotation,
const DWFString zName = L"",
const DWFString zID = L""
throw ()
 

Constructor

Parameters:
eType Specifies whether this is a published or a marked up coordinate system.
anOrigin The CoordinateSystem origin.
anRotation The CoordinateSystem rotation matrix in row-major configuration.
zName An optional user-friendly name for this CoordinateSystem.
zID An optional identifier used when referencing this CoordinateSystem.
Exceptions:
None 

_DWFTK_API DWFToolkit::DWFCoordinateSystem::DWFCoordinateSystem const DWFCoordinateSystem rCoordinateSystem  )  throw ()
 

Copy Constructor

Parameters:
rCoordinateSystem The source CoordinateSystem from which to copy.
Exceptions:
None 

virtual _DWFTK_API DWFToolkit::DWFCoordinateSystem::~DWFCoordinateSystem  )  throw () [virtual]
 

Destructor

Exceptions:
None 


Member Function Documentation

_DWFTK_API const DWFString& DWFToolkit::DWFCoordinateSystem::getID  )  const throw () [inline]
 

Gets the ID for this CoordinateSystem

Returns:
The ID
Exceptions:
None 

Definition at line 196 of file CoordinateSystem.h.

_DWFTK_API const DWFString& DWFToolkit::DWFCoordinateSystem::getName  )  const throw () [inline]
 

Gets the user-friendly name for this CoordinateSystem

Returns:
The user-friendly name
Exceptions:
None 

Definition at line 183 of file CoordinateSystem.h.

_DWFTK_API const double* DWFToolkit::DWFCoordinateSystem::getOrigin  )  const throw () [inline]
 

Gets the origin of this CoordinateSystem

Returns:
The origin of the CoordinateSystem.
Exceptions:
None 

Definition at line 157 of file CoordinateSystem.h.

_DWFTK_API const double* DWFToolkit::DWFCoordinateSystem::getRotation  )  const throw () [inline]
 

Gets the rotation matrix of this CoordinateSystem

Returns:
The rotation matrix of the CoordinateSystem as an array of doubles in row-major configuration.
Exceptions:
None 

Definition at line 170 of file CoordinateSystem.h.

_DWFTK_API teType DWFToolkit::DWFCoordinateSystem::getType  )  const throw () [inline]
 

Gets the type of this CoordinateSystem

Returns:
The type
Exceptions:
None 

Definition at line 209 of file CoordinateSystem.h.

_DWFTK_API DWFCoordinateSystem& DWFToolkit::DWFCoordinateSystem::operator= const DWFCoordinateSystem rCoordinateSystem  )  throw ()
 

Assignment Operator

Parameters:
rCoordinateSystem The source CoordinateSystem from which to copy.
Exceptions:
None 

virtual _DWFTK_API void DWFToolkit::DWFCoordinateSystem::parseAttributeList const char **  ppAttributeList  )  throw ( DWFException ) [virtual]
 

Implements DWFCore::DWFXMLBuildable.

_DWFTK_API void DWFToolkit::DWFCoordinateSystem::serializeXML DWFXMLSerializer rSerializer,
unsigned int  nFlags
throw ( DWFException )
 

_DWFTK_API void DWFToolkit::DWFCoordinateSystem::set teType  eType,
const double *  anOrigin,
const double *  anRotation,
const DWFString zName = L"",
const DWFString zID = L""
throw ()
 

Sets the origin, rotation, name and optionally the ID for this CoordinateSystem

Parameters:
eType Specifies whether this is a published or a marked up coordinate system.
anOrigin The CoordinateSystem origin.
anRotation The CoordinateSystem rotation matrix in row-major configuration.
zName An optional user-friendly name for this CoordinateSystem.
zID An optional identifier used when referencing this CoordinateSystem.
Returns:
None
Exceptions:
None 


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:40:28 2009 for Autodesk DWF Toolkit by  doxygen 1.4.5