diguyLinkController.h

Go to the documentation of this file.

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

/*********************************************************************/
#pragma once

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

#ifdef CPLUSPLUS_ONLY
#include <diguy_constants.h>

class bdiLink;
class bdiLinkController;
class diguyCharacter;
class diguyLinkController;
class diguyGraphicsShape;
class diguyGraphicsShaderInstance;

#endif

#include <declspec_diguy.h>

//------------------------------------------------------------------------------        
class BDI_DECLSPEC_diguy diguyLinkController
{

public:

/*****************************************************************************/
        /*l
         *b  Description:
         **
         **    Returns the name of the link.  This pointer will never be NULL.
         **
         *b  Returns:
         **
         **    name of the link that this controller modifies
         */
        const char* get_name();

        int set_translation_override(float x, float y, float z, float ramp_time = .25f);

        int set_translation_override(float x, float y, float z, float vx, float vy, float vz, float ramp_time = .25f);

        int set_translation_velocity(float vx, float vy, float vz, float ramp_time = .25f);

        int end_translation_override(float ramp_time = .25f);

        int set_translation_additive(int additive);

        int set_translation_post_rotation(int post_rotation);
        
        int set_translation_restore_time(float snap_back_time);

        int set_rotation_override(float rz, float rx, float ry, float ramp_time = .25f);

        int set_rotation_override(float rz, float rx, float ry, float vrz, float vrx, float vry, float ramp_time = .25f);

        int set_rotation_velocity(float vrz, float vrx, float vry, float ramp_time = .25f);

        int end_rotation_override(float ramp_time = .25f);

        int set_rotation_additive(int additive);

        int set_rotation_restore_time(float time);
        

#ifdef CPLUSPLUS_ONLY

        bdiLinkController* get_scripted_object() {return m_scripted_object;}

protected:

        /*l
         **    A protected constructor.  Constructors are called automatically
         **    by DI-Guy.
         */
        diguyLinkController(bdiLinkController* internal_data);

        /*l
         **    A protected destructor.  Destructors are called automatically
         **    by DI-Guy.
         */
        virtual ~diguyLinkController();

private:

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

        friend class bdiLink;
        friend class bdiLinkController;

#endif

};