diguyAuthorVisualRegionMesh.h

Go to the documentation of this file.

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

#ifndef __diguyAuthorVisualRegionMesh_H
#define __diguyAuthorVisualRegionMesh_H

#include <declspec_diguy.h>
class diguyAuthorVisualMaterial;
class diguyAuthorVisualRegionMesh;
class diguyVec3f;
class diguyRegion;
class bdiRenderRegionMeshData;

typedef diguyAuthorVisualRegionMesh* diguyAuthorVisualRegionMeshCreateFunc(void* internal_data);


/*l
 **  Function for setting the create function for region mesh 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_region_mesh_visual_create_func(diguyAuthorVisualRegionMeshCreateFunc* func);



/*********************************************************************/
class BDI_DECLSPEC_diguy diguyAuthorVisualRegionMesh
{

public:

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

   /*l
    **  Returns the diguyRegion object that this visual is associated with.
    **  Note that one diguyRegion will most likely have multiple region mesh
    **  visuals.
    */
   diguyRegion* get_region();

   /*l
    **  Returns the index of the subregion of the associated diguyRegion that
    **  this visual is part of.  This value will be one of the
    **  diguySubregionIndex enumerated values.
    */
   int get_subregion_index();

   /*l
    **  Returns the number of quad polygons to be rendered by this visual.
    **  They should be rendered using the material's brush color.
    */
   int get_num_quads();

   /*l
    **  Returns one corner of one of the visual's quads.  Corner argument
    **  should be between 0 and 3, quad argument between 0 and the result
    **  from get_num_quads() - 1.
    **
    **  The returned vertex will be relative to the region's origin as
    **  returned by get_mesh_origin().
    **
    **  Note: this will be slow.  Use get_quads_data_ptr() if possible.
    */
   diguyVec3f get_quad_point(int quad, int corner);

   /*l
    **  Returns a pointer to a contiguous data buffer that contains all
    **  quad polygon data for this visual.  There will be four times the
    **  value returned by get_num_quads() vectors in the data buffer.
    **
    **  The returned vertices will be relative to the region's origin as
    **  returned by get_mesh_origin().
    */
   diguyVec3f* get_quads_data_ptr();

   /*l
    **  Returns the number of line segment edges to be rendered by this
    **  visual.  They should be rendered using the material's pen color.
    */
   int get_num_edges();

   /*l
    **  Returns one endpoint of one of the visual's edges.  End argument
    **  should be 0 or 1, edge argument between 0 and the result from
    **  get_num_edges() - 1.
    **
    **  The returned vertex will be relative to the region's origin as
    **  returned by get_mesh_origin().
    **
    **  Note: this will be slow.  Use get_edges_data_ptr() if possible.
    */
   diguyVec3f get_edge_point(int edge, int end);

   /*l
    **  Returns a pointer to a contiguous data buffer that contains all
    **  line segment edge data for this visual.  There will be two times the
    **  value returned by get_num_edges() vectors in the data buffer.
    **
    **  The returned vertices will be relative to the region's origin as
    **  returned by get_mesh_origin().
    */
   diguyVec3f* get_edges_data_ptr();

   /*l
    **  Returns the origin of the geometry in the visual.  All quads and
    **  edges will be relative to this origin.
    */
   diguyVec3f get_mesh_origin();

   /*l
    **  Returns the level at which this mesh should be highlighted.  This
    **  will be 0, 1, or 2.  The higher the highlight level, the brighter
    **  the mesh should appear.
    **
    **  It's recommended that for highlight level 0, the colors of the visual
    **  material be scaled by a factor of 0.6; for highlight level 1, by a
    **  factor of 0.8; and for highlight level 2 don't scale.
    **
    **  Highlight level 2 should have a wider line width than levels 0 or 1.
    */
   int get_highlight_level();

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


/*****************************************************************************/
   /*l
    *b  Description:
    **
    **    build() will be called by DI-Guy when it is time for a
    **    renderer-specific visual object to be created.  All information
    **    necessary to build the visual should be available via the Accessor
    **    Functions above when this function is called.
    **
    **    It is common for build() and update() to use the same internal,
    **    user-written function for creating geometry.
    **
    *i  Immediate Mode:
    **
    **    Immediate mode renderers may override this function to create an
    **    object, for example a vertex array, that may be used when draw() is
    **    called.
    **
    *i  Scene Graph:
    **
    **    Scene graph renderers almost always override this function to
    **    create a scene graph node object that is attached to the scene
    **    graph and updated when update() is called.
    */
   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.  Specifics for this visual type are below.
    **
    *i    DIGUY_GRAPHICS_VISUAL_UPDATE_GEOMETRY
    **
    **      Region mesh visuals need to use calls to get_num_quads(),
    **      get_quads_data_ptr(), etc. to determine geometry.
    **
    *i    DIGUY_GRAPHICS_VISUAL_UPDATE_POSITION
    **
    **      Region mesh visuals do not use this value.  The overall positions
    **      of polygons that make up the mesh are recomputed and applied
    **      during an overall geometry update operation.
    */
   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 diguyAuthorVisualRegionMeshCreateFunc* s_create_func;

   diguyAuthorVisualRegionMesh(void* internal_data);
   virtual ~diguyAuthorVisualRegionMesh();

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

   friend class bdiRenderRegionMeshData;
};

#endif /* __diguyAuthorVisualRegionMesh_H */