CTR Pia  4.11.3
Game Communication Engine
nn::pia::reckoning Namespace Reference

Represents the PiaReckoning namespace. More...

Classes

class  ReckoningCloneElement
 Manages the sending and receiving of values while using dead reckoning. More...
 
class  ReckoningCloneElementBase
 This is the base class for managing the sending and receiving of data while using dead reckoning. More...
 
class  Simple3dReckoningStrategy
 The ReckoningStrategy class interpolates 3D vectors using linear evaluation functions. More...
 
class  Vector3f
 The Vector3f class provides functionality for the strategy used to handle 3D vectors. More...
 

Functions

nn::Result BeginSetup (void)
 Declares the start of setup. More...
 
nn::Result EndSetup (void)
 Declares the end of setup. More...
 
void Finalize (void)
 Finalizes the reckoning module. This function does nothing and returns if it is called before the Initialize function has been called. More...
 
nn::Result Initialize (void)
 Initializes the reckoning module. More...
 
bool IsInitialized (void)
 Gets whether the reckoning module is initialized. More...
 

Detailed Description

Represents the PiaReckoning namespace.


Revision History:
2013-10-29 Initial version.

Function Documentation

nn::Result nn::pia::reckoning::BeginSetup ( void  )

Declares the start of setup.

Returns
Returns a Result value indicating success if called at the right time. You must make sure that the implementation of this function in your application does not return any errors.
Error Return Values:

ResultNotInitialized Indicates that the reckoning::Initialize function has not been called. Programming error. Fix your program so that this error is not returned.

ResultInvalidState Indicates that the function was called at the wrong time. Programming error. Fix your program so that this error is not returned.

See also
EndSetup
nn::Result nn::pia::reckoning::EndSetup ( void  )

Declares the end of setup.

Returns
Returns a Result value indicating success if called at the right time. You must make sure that the implementation of this function in your application does not return any errors.
Error Return Values:

ResultNotInitialized Indicates that the reckoning::Initialize function has not been called. Programming error. Fix your program so that this error is not returned.

ResultInvalidState Indicates that the function was called at the wrong time. Programming error. Fix your program so that this error is not returned.

See also
BeginSetup
void nn::pia::reckoning::Finalize ( void  )

Finalizes the reckoning module. This function does nothing and returns if it is called before the Initialize function has been called.

See also
IsInitialized, Initialize
nn::Result nn::pia::reckoning::Initialize ( void  )

Initializes the reckoning module.

Returns
Returns a Result value indicating success if initialization succeeds. You must make sure that the implementation of this function in your application does not return any errors.
Error Return Values:
ResultAlreadyInitialized The module is already initialized. Programming error. Fix your program so that this error is not returned.
See also
IsInitialized, Finalize
bool nn::pia::reckoning::IsInitialized ( void  )

Gets whether the reckoning module is initialized.

Returns
Returns true if it is initialized, and false otherwise.
See also
Initialize, Finalize