
This file was automatically generated from comments in the C/C++ header file diguyCharacterPath.h. Do not edit this file directly; the changes will be lost. Please mail suggestions or corrections to diguy@bdi.com
Includes: diguy_constants.h | declspec_diguy.h
class diguyCharacterPath
|
class BDI_DECLSPEC_diguy diguyCharacterPath { public: const char* get_name(); diguyCharacter* get_character(); #ifdef CPLUSPLUS_ONLY enum { CALLBACK_ID_TIME_LEFT = 1, CALLBACK_ID_TIME_INTO }; int add_callback(int callback_id, diguyCharacterPathCallback* callback, void* callback_params = 0, void* callback_user_data = 0); int remove_callback(int callback_id, diguyCharacterPathCallback* callback); int remove_callback_with_user_data(int callback_id, void* callback_user_data); #ifdef CPLUSPLUS_ONLY bdiScenarioPath* get_scripted_object() {return m_path;} };
function diguyCharacterPath::get_name |
Prototype:
Description:const char* get_name();
Returns the name of the path. This pointer will never be NULL.Callable From:
Returns:
- C++
- Script
name of the path
function diguyCharacterPath::get_character |
Prototype:
Callable From:diguyCharacter* get_character();
Returns:
- C++
- Script
character that owns this path
enumeration |
Description:enum { CALLBACK_ID_TIME_LEFT = 1, CALLBACK_ID_TIME_INTO };
This is an enumeration of the different callbacks that can be registered with add_callback().Usable From:
- C++
- Script
function diguyCharacterPath::add_callback |
Prototype:
Description:int add_callback(int callback_id, diguyCharacterPathCallback* callback, void* callback_params = 0, void* callback_user_data = 0);
This function adds a user callback.Arguments:
callback pointer to function with prototype diguyCharacterPathCallback (typedefed above) callback_id integer id of when this callback is to be called callback_params struct containing additional parameters needed by some callbacks callback_user_data pointer for user's own use; DI-Guy will do nothing to the contents of this pointer beyond passing it back when the callback is invoked callback_id should be one of the following values:CALLBACK_ID_TIME_LEFT
This callback will be called whenever the character that is following this path has a specified number of seconds left on this path. The number of seconds left is specified by the t parameter.
callback_params should be a pointer to a diguyCharacterPathCallbackParams_TIME_LEFT structure.CALLBACK_ID_TIME_INTO
This callback will be called whenever the character that is following this path has gone a specified number of seconds into this path. The number of seconds at which the callback should be called is specified by the t parameter.
callback_params should be a pointer to a diguyCharacterPathCallbackParams_TIME_INTO structure.
Callbacks return a value of type diguyCallbackReturn, which will be DIGUY_CALLBACK_STOP or DIGUY_CALLBACK_CONTINUE. If the callback returns DIGUY_CALLBACK_STOP, the default handler of the function will not be called; the callback is asserting that it has done everything necessary for the function call. If the callback returns DIGUY_CALLBACK_CONTINUE, the default handler for the function will be called after the callback.Callable From:
Returns:
- C++
0 on success, -1 on failure
function diguyCharacterPath::remove_callback |
Prototype:
int remove_callback(int callback_id, diguyCharacterPathCallback* callback);
function diguyCharacterPath::remove_callback_with_user_data |
Prototype:
int remove_callback_with_user_data(int callback_id, void* callback_user_data);
function diguyCharacterPath::get_scripted_object |
Prototype:
bdiScenarioPath* get_scripted_object();
Boston Dynamics
ALL RIGHTS RESERVED.
These coded instructions, statements, and computer programs contain unpublished proprietary information of Boston Dynamics and are protected by Copyright Laws of the United States. They may not be used, duplicated, or disclosed in any form, in whole or in part, without the prior written consent from Boston Dynamics.
RESTRICTED RIGHTS LEGEND
Use, duplication, or disclosure by the government is subject to restrictions as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Sofware clause at DFARS 252.227-7013 and/or in similar or successor clauses in the FAR, or the DOD or NASA FAR Supplement, or to subparagraphs (c)(1) and (c)(2) of the Commercial Computer Software--Restricted Rights at 48 CFR 52.227-19, as applicable. Unpublished-rights reserved under the Copyright Laws of the United States.
Contractor/Manufacturer is:
Boston Dynamics/515 Massachusetts Avenue/Cambridge MA 02139.