diguyCharacterPathEvent.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 1992-2015 VT MAK
 ** All rights reserved. 
 *********************************************************************/

/*********************************************************************
 **
 *t  diguyCharacterPathEvent
 **
 *b    Link against: libdiguy
 */

#ifndef __diguyCharacterPathEvent_H
#define __diguyCharacterPathEvent_H

#ifdef SWIG
%module diguyCharacterPathEvent
#else
#define CPLUSPLUS_ONLY
#endif

#ifdef CPLUSPLUS_ONLY

class bdiBeadEvent;
class diguyCharacterPathEvent;
class diguyCharacter;
class diguyCharacterPath;

#endif /* CPLUSPLUS_ONLY */


#include <declspec_diguy.h>

/****************************************************************************/
class BDI_DECLSPEC_diguy diguyCharacterPathEvent
{

public:

        /*l
         *b  Description:
         **
         **    Returns the name of the bead.  This pointer will
         **    never be NULL.
         **
         *b  Returns:
         **
         **    name of the bead
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        const char* get_name();

        /*l
         *b  Description:
         **
         **    This function returns a pointer to the character
         **    owning this event bead.
         **
         *b  Returns:
         **
         **    pointer of type diguyCharacter
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyCharacter* get_character();

        /*l
         *b  Description:
         **
         **    This function returns a pointer to the path
         **    owning this event bead.
         **
         *b  Returns:
         **
         **    pointer of type diguyCharacterPath
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyCharacterPath* get_path();

        /*l
         *b  Returns:
         **
         **    returns how far the character is into this
         **    bead.  This is a normalized value.  0 means beginning of
         **    bead, 0.5 means halfway through, 1 means end of bead
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        float get_how_far();


private:

#ifdef CPLUSPLUS_ONLY

        /*l
         **    A private constructor.
         */
        diguyCharacterPathEvent(bdiBeadEvent* bead);

        /*l
         **    A pointer to internal data.
         */
        bdiBeadEvent* m_scripted_object;

        friend class bdiBeadEvent;

#endif /* CPLUSPLUS_ONLY */

};

#endif /* __diguyCharacterPathEvent_H */