C++ SDK Reference  12.5
 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-2013 Boston Dynamics
4  * ALL RIGHTS RESERVED.
5  *
6  * These coded instructions, statements, and computer programs
7  * contain unpublished proprietary information of Boston Dynamics
8  * and are protected by Copyright Laws of the United States.
9  * They may not be used, duplicated, or disclosed in any form, in
10  * whole or in part, without the prior written consent from Boston
11  * Dynamics.
12  *
13  * RESTRICTED RIGHTS LEGEND
14  * Use, duplication, or disclosure by the government is subject
15  * to restrictions as set forth in FAR 52.227.19(c)(2) or
16  * subparagraph (c)(1)(ii) of the Rights in Technical Data and
17  * Computer Software clause at DFARS 252.227-7013 and/or in
18  * similar or successor clauses in the FAR, or the DOD or NASA
19  * FAR Supplement, or to subparagraphs (c)(1) and (c)(2) of the
20  * Commercial Computer Software--Restricted Rights at 48 CFR
21  * 52.227-19, as applicable. Unpublished-rights reserved under
22  * the Copyright Laws of the United States.
23  * Contractor/Manufacturer is:
24  * Boston Dynamics/78 Fourth Avenue/Waltham MA 02451.
25  */
26 
27 /*********************************************************************
28  **
29  *t diguyCharacterPathEvent
30  **
31  *b Link against: libdiguy
32  */
33 
34 #ifndef __diguyCharacterPathEvent_H
35 #define __diguyCharacterPathEvent_H
36 
37 #ifdef SWIG
38 %module diguyCharacterPathEvent
39 #else
40 #define CPLUSPLUS_ONLY
41 #endif
42 
43 #ifdef CPLUSPLUS_ONLY
44 
45 class bdiBeadEvent;
46 class diguyCharacterPathEvent;
47 class diguyCharacter;
48 class diguyCharacterPath;
49 
50 #endif /* CPLUSPLUS_ONLY */
51 
52 
53 #include <declspec_diguy.h>
54 
55 /****************************************************************************/
56 class BDI_DECLSPEC_diguy diguyCharacterPathEvent
57 {
58 
59 public:
60 
61  /*l
62  *b Description:
63  **
64  ** Returns the name of the bead. This pointer will
65  ** never be NULL.
66  **
67  *b Returns:
68  **
69  ** name of the bead
70  **
71  *b Callable From:
72  **
73  *- - C++
74  *- - Script
75  */
76  const char* get_name();
77 
78  /*l
79  *b Description:
80  **
81  ** This function returns a pointer to the character
82  ** owning this event bead.
83  **
84  *b Returns:
85  **
86  ** pointer of type diguyCharacter
87  **
88  *b Callable From:
89  **
90  *- - C++
91  *- - Script
92  */
93  diguyCharacter* get_character();
94 
95  /*l
96  *b Description:
97  **
98  ** This function returns a pointer to the path
99  ** owning this event bead.
100  **
101  *b Returns:
102  **
103  ** pointer of type diguyCharacterPath
104  **
105  *b Callable From:
106  **
107  *- - C++
108  *- - Script
109  */
110  diguyCharacterPath* get_path();
111 
112  /*l
113  *b Returns:
114  **
115  ** returns how far the character is into this
116  ** bead. This is a normalized value. 0 means beginning of
117  ** bead, 0.5 means halfway through, 1 means end of bead
118  **
119  *b Callable From:
120  **
121  *- - C++
122  *- - Script
123  */
124  float get_how_far();
125 
126 
131 private:
132 
133 #ifdef CPLUSPLUS_ONLY
134 
135  /*l
136  ** A private constructor.
137  */
138  diguyCharacterPathEvent(bdiBeadEvent* bead);
139 
140  /*l
141  ** A pointer to internal data.
142  */
143  bdiBeadEvent* m_scripted_object;
144 
145  friend class bdiBeadEvent;
146 
147 #endif /* CPLUSPLUS_ONLY */
148 
149 };
150 
151 #endif /* __diguyCharacterPathEvent_H */