diguyAuthorVisualRegionPaintbrush.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 1992-2022 MAK Technologies, Inc.
 ** All rights reserved. 
 *********************************************************************/

#ifndef __diguyAuthorVisualRegionPaintbrush_H
#define __diguyAuthorVisualRegionPaintbrush_H

#include <declspec_diguy.h>
#include <diguy_constants.h>
class bdiNavMeshInterface;
class diguyAuthorVisualMaterial;
class diguyAuthorVisualRegionPaintbrush;
class diguyVec3f;

typedef diguyAuthorVisualRegionPaintbrush* diguyAuthorVisualRegionPaintbrushCreateFunc(void* internal_data);


/*l
 **  Function for setting the create function for region paintbrush 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_region_paintbrush_visual_create_func(diguyAuthorVisualRegionPaintbrushCreateFunc* func);


/*********************************************************************
 **
 *t  diguyAuthorVisualRegionPaintbrush
 **
 *b    Link against: libdiguy
 **
 ** \brief
 **
 **    The diguyAuthorVisualRegionPaintbrush class provides an interface for
 **    creating supplemental visuals needed for creating DI-Guy scenarios in a
 **    Host IG.
 **
 **    Region paintbrush visuals are used to visualize the 3D paintbrush used
 **    to show where painted regions and meshes will appear.
 **
 **    Paintbrushes are commonly shown as translucent spheres when they will
 **    add to the region, or a yellow pencil-like column when they will erase
 **    from the region.
 */
class BDI_DECLSPEC_diguy diguyAuthorVisualRegionPaintbrush
{

public:

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

        /*l
         **  Returns the current position of the paintbrush in meters from the
         **  DI-Guy origin.
         */
        diguyVec3f get_position();

        /*l
         **  Returns the index of the subregion the paintbrush will paint into.
         **  This will be a diguySubregionIndex enumeration value.
         */
        diguySubregionIndex get_painting_subregion();

        /*l
         **  Sets the index of the subregion the paintbrush will paint into.
         */
        void set_painting_subregion(diguySubregionIndex subregion_index);

        /*l
         **  Returns the current paintbrush mode, a diguyRegionPaintbrushMode
         **  enumeration value.
         */
        diguyRegionPaintbrushMode get_paintrush_mode();

        /*l
         **  Sets what happens when a paintbrush stroke is applied
         **  in input modes DIGUY_SCENARIO_INPUT_MODE_REGION_PAINTER and
         **  DIGUY_SCENARIO_INPUT_MODE_CROWD_EDITOR.
         */
        void set_paintrush_mode(diguyRegionPaintbrushMode mode);

        /*l
         **  Returns the radius of the paintbrush.
         */
        float get_brush_size();

        /*l
         **  Sets the radius of the paintbrush.
         */
        void set_brush_size(float radius);

        /*l
         **  Returns 1 if the paintbrush should be shown as an eraser, else 0.
         */
        int get_brush_is_eraser();

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


/*****************************************************************************
 **
 *2  Virtual Functions
 **
 **    The functions in this section are all virtual functions that will
 **    be called by DI-Guy Author at various times during DI-Guy execution.
 **    Most visuals have a similar set of virtual functions.
 **
 **    Because the functions are all virtual, DI-Guy programmers can create
 **    a subclass of this class and override them.  Unless otherwise stated,
 **    the base class functions do not need to be called.
 */

        /*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
         **
         **      Paintbrushes are commonly shown as translucent spheres when they
         **      will add to the region, or a yellow pencil-like column when they
         **      will erase from the region.
         */
        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();




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

        static diguyAuthorVisualRegionPaintbrushCreateFunc* s_create_func;

protected:

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

        bdiNavMeshInterface* m_scripted_object;
        bdiNavMeshInterface* get_scripted_object() {return m_scripted_object;}

        diguyAuthorVisualMaterial* m_visual_material;

        friend class bdiNavMesh;
        friend class bdiNavMeshInterface;
};

#endif /* __diguyAuthorVisualRegionPaintbrush_H */