diguyAuthorVisualObjectHandle.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2024 MAK Technologies, Inc.
 * All rights reserved.
 ****************************************************************************/

#ifndef __diguyAuthorVisualObjectHandle_H
#define __diguyAuthorVisualObjectHandle_H

#include <declspec_diguy.h>
#include <diguy_typedefs.h>
#include <diguy_vector_classes.h>
class diguyAuthorVisualMaterial;
class diguyAuthorVisualObjectHandle;
class bdiFarPosition;
class bdiGeometryVisualMaterial;
class bdiVec3f;

typedef diguyAuthorVisualObjectHandle* diguyAuthorVisualObjectHandleCreateFunc(void* internal_data);


/*l
 **  Function for setting the create function for object handle visual
 **  subclass objects.  This should be called after diguy_author_initialize(),
 **  but before any scenario is created of loaded.
 */
BDI_DECLSPEC_diguy void diguy_author_set_object_handle_visual_create_func(diguyAuthorVisualObjectHandleCreateFunc* func);



/*********************************************************************/
class BDI_DECLSPEC_diguy diguyAuthorVisualObjectHandle
{

public:

   /*l
    **  Returns the visual material to be used for rendering this object.
    */
   diguyAuthorVisualMaterial* get_visual_material();

   /*l
    **  The shapes the handle can have.
    **
    *i    HANDLE_SHAPE_CYLINDER
    **
    **      A cylinder oriented along the Z axis, with its base at the
    **      origin.
    **
    *i    HANDLE_SHAPE_CONE
    **
    **      A cone oriented along the Z axis, with its base at the origin.
    **      If get_inverted() returns 1, the point will be at the origin.
    **
    *i    HANDLE_SHAPE_SPHERE
    **
    **      A sphere, centered at the origin.
    **
    *i    HANDLE_SHAPE_PATH_BEAD
    **
    **      Usually a plus sign with depth, oriented so it can rotate around
    **      the X axis.
    **
    *i    HANDLE_SHAPE_PATH_STOP_SIGN
    **
    **      Usually an octagon with depth, oriented so it can rotate around
    **      the X axis.
    */
   enum {
      HANDLE_SHAPE_CYLINDER = 0,
      HANDLE_SHAPE_CONE,
      HANDLE_SHAPE_SPHERE,
      HANDLE_SHAPE_PATH_BEAD,
      HANDLE_SHAPE_PATH_STOP_SIGN
   };

   /*l
    **  Returns the handle shape.  This will be one of the enum values above.
    */
   int get_handle_shape() {return m_handle_shape;}

   /*l
    **  Returns the handle radius, for those shapes that have one, including:
    **
    *-    - cylinder
    *-    - cone
    *-    - sphere
    *-    - path_bead
    *-    - path_stop_sign
    */
   float get_radius();

   /*l
    **  Returns the handle height, for those shapes that have one, including:
    **
    *-    - cylinder
    *-    - cone
    */
   float get_height();

   /*l
    **  Returns the bead depth along the X axis, for those shapes that have
    **  one, including:
    **
    *-    - path_bead
    *-    - path_stop_sign
    */
   float get_bead_depth();

   /*
    *  Used for:
    *
    **  Returns the bead thickness, for those shapes that have one,
    **  including:
    **
    *-    - path_bead
    */
   float get_bead_arm_thickness();

   /*l
    **  Returns whether the handle shape should be inverted.  Valid for:
    **
    *-    - cone
    */
   int get_inverted();

   /*l
    **  Returns the position, in meters from the origin, of the object handle
    **  in the DI-Guy global coordinate system.  See
    **  diguyCharacter::set_position() for a description of the coordinate
    **  system.
    */
   diguyVec3f get_position();

   /*l
    **  Returns the high precision position of the object handle.
    */
   diguyVec3d get_position_double();

   /*l
    **  Returns the orientation, in degrees, of the object handle in the
    **  DI-Guy global coordinate system.  See
    **  diguyCharacter::set_position() for a description of the coordinate
    **  system.
    */
   diguyVec3f get_orientation();

   /*l
    **  Returns the uid (unique identifier) of this object handle.
    */
   long get_uid();

   /*l
    **  Returns 1 if this visual should be visible, else 0.
    */
   int get_visible();


/*****************************************************************************/
   /*l
    *b  Description:
    **
    **    See diguyAuthorVisualWaypoint::build() for general information
    **    about this function.
    */
   virtual void build();

   /*l
    *b  Description:
    **
    **    See diguyAuthorVisualWaypoint::unbuild() for general information
    **    about this function.
    */
   virtual void unbuild();

   /*l
    *b  Description:
    **
    **    See diguyAuthorVisualWaypoint::update() for general information
    **    about this function.
    **
    *i    DIGUY_GRAPHICS_VISUAL_UPDATE_GEOMETRY
    **
    **      Object handles have different shapes based on the handle shape
    **      returned by get_handle_shape().
    */
   virtual void update(int update_flags);

   /*l
    *b  Description:
    **
    **    See diguyAuthorVisualWaypoint::draw() for general information
    **    about this function.
    */
   virtual void draw();

   /*l
    *b  Description:
    **
    **    See diguyAuthorVisualWaypoint::show() for general information
    **    about this function.
    */
   virtual void show();

   /*l
    *b  Description:
    **
    **    See diguyAuthorVisualWaypoint::hide() for general information
    **    about this function.
    */
   virtual void hide();



/****************************************************************************/
/****************************************************************************/

protected:

   friend class bdiScenarioCharacter;
   friend class bdiBead;
   friend class bdiBeadAction;
   friend class bdiScenarioEditor;

   // protected constructor and destructor
   diguyAuthorVisualObjectHandle(void* internal_data);
   virtual ~diguyAuthorVisualObjectHandle();

   void set_shape_to_selection_disk(float radius = 0.5f,
      float height = 0.05f);
   void set_shape_to_selection_cone(float radius = 0.17f,
      float height = 0.3f);
   void set_shape_to_sphere(float radius);
   void set_shape_to_path_bead();
   void set_shape_to_path_stop_sign();
   void set_internal_material(bdiGeometryVisualMaterial* mtl); // owns becomes false

public:
   static diguyAuthorVisualObjectHandleCreateFunc* s_create_func;
protected:

   void* m_internal_data;

   bdiGeometryVisualMaterial* m_internal_material;
   bool                       m_owns_internal_material;

   int         m_handle_shape;
   float       m_size1;
   float       m_size2;
   float       m_size3;
   int         m_inverted;

   bdiFarPosition* m_position;
   bdiVec3f*       m_orientation;

   long       m_uid;
   int        m_visible;
};

#endif /* __diguyAuthorVisualObjectHandle_H */