DI-Guy C++ SDK Reference  13.0
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
diguyCharacterPathEvent.h
Go to the documentation of this file.
1 
2 /*********************************************************************
3  ** Copyright (c) 1992-2014 VT MAK
4  ** All rights reserved.
5  *********************************************************************/
6 
7 /*********************************************************************
8  **
9  *t diguyCharacterPathEvent
10  **
11  *b Link against: libdiguy
12  */
13 
14 #ifndef __diguyCharacterPathEvent_H
15 #define __diguyCharacterPathEvent_H
16 
17 #ifdef SWIG
18 %module diguyCharacterPathEvent
19 #else
20 #define CPLUSPLUS_ONLY
21 #endif
22 
23 #ifdef CPLUSPLUS_ONLY
24 
25 class bdiBeadEvent;
26 class diguyCharacterPathEvent;
27 class diguyCharacter;
28 class diguyCharacterPath;
29 
30 #endif /* CPLUSPLUS_ONLY */
31 
32 
33 #include <declspec_diguy.h>
34 
35 /****************************************************************************/
36 class BDI_DECLSPEC_diguy diguyCharacterPathEvent
37 {
38 
39 public:
40 
41  /*l
42  *b Description:
43  **
44  ** Returns the name of the bead. This pointer will
45  ** never be NULL.
46  **
47  *b Returns:
48  **
49  ** name of the bead
50  **
51  *b Callable From:
52  **
53  *- - C++
54  *- - Script
55  */
56  const char* get_name();
57 
58  /*l
59  *b Description:
60  **
61  ** This function returns a pointer to the character
62  ** owning this event bead.
63  **
64  *b Returns:
65  **
66  ** pointer of type diguyCharacter
67  **
68  *b Callable From:
69  **
70  *- - C++
71  *- - Script
72  */
73  diguyCharacter* get_character();
74 
75  /*l
76  *b Description:
77  **
78  ** This function returns a pointer to the path
79  ** owning this event bead.
80  **
81  *b Returns:
82  **
83  ** pointer of type diguyCharacterPath
84  **
85  *b Callable From:
86  **
87  *- - C++
88  *- - Script
89  */
90  diguyCharacterPath* get_path();
91 
92  /*l
93  *b Returns:
94  **
95  ** returns how far the character is into this
96  ** bead. This is a normalized value. 0 means beginning of
97  ** bead, 0.5 means halfway through, 1 means end of bead
98  **
99  *b Callable From:
100  **
101  *- - C++
102  *- - Script
103  */
104  float get_how_far();
105 
106 
111 private:
112 
113 #ifdef CPLUSPLUS_ONLY
114 
115  /*l
116  ** A private constructor.
117  */
118  diguyCharacterPathEvent(bdiBeadEvent* bead);
119 
120  /*l
121  ** A pointer to internal data.
122  */
123  bdiBeadEvent* m_scripted_object;
124 
125  friend class bdiBeadEvent;
126 
127 #endif /* CPLUSPLUS_ONLY */
128 
129 };
130 
131 #endif /* __diguyCharacterPathEvent_H */