diguyAuthorVisualMaterial.h

Go to the documentation of this file.

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



#ifndef __diguyAuthorVisualMaterial_H
#define __diguyAuthorVisualMaterial_H

#include <declspec_diguy.h>
#include <diguy_vector_classes.h>
class bdiGeometryVisualMaterial;


/*********************************************************************/
class BDI_DECLSPEC_diguy diguyAuthorVisualMaterial
{

public:

        /*l
         **  Returns the name of this material.
         */
        const char* get_name();


/*****************************************************************************/
        /*l
         **  Returns the material's primary brush color.  The brush color is used
         **  to fill the polygons of visuals.
         **
         **  The returned vector is an RGBA color vector, with color channel
         **  values between 0 and 1.
         */
        diguyVec4f get_brush_color();

        /*l
         **  Returns the suggested number of "layers", or vertical divisions, that
         **  should be used to construct polygonal solids such as spheres, cones,
         **  cylinders, and other shapes that need linear approximations of
         **  circular data.
         **
         **  Analogous to layers in a round cake.
         */
        int get_num_layers();  // number "vertical" divisions

        /*l
         **  Returns the suggested number of "slices", or radial divisions, that
         **  should be used to construct polygonal solids such as spheres, cones,
         **  cylinders, and other shapes that need linear approximations of
         **  circular data.
         **
         **  Analogous to slices in a round cake.
         */
        int get_num_slices();

        /*l
         **  Returns 1 if faces in should be visible, 0 if not.  This is the same
         **  as checking whether the brush color alpha component equals 0
         **  (complete transparency).
         **
         **  Shortcut for checking brush alpha not equal to 0.
         */
        int get_fill_faces();


/*****************************************************************************/
        /*l
         **  Returns the material's primary pen color.  The pen color is used for
         **  line segments and edges of visuals.
         **
         **  The returned vector is an RGBA color vector, with color channel
         **  values between 0 and 1.
         */
        diguyVec4f get_pen_color();

        /*l
         **  Returns the material's secondary pen color.  The secondary pen isn't
         **  used by a visual unless the visual's documentation explicitly says it
         **  is.
         */
        diguyVec4f get_pen2_color();

        /*l
         **  Returns the recommended width of line segments.
         */
        float get_line_width();

        /*l
         **  Returns 1 if edge line segments should be visible, 0 if not.  This is
         **  the same as checking whether the pen color alpha component equals 0
         **  (complete transparency).
         */
        int get_edge_faces();



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

        bdiGeometryVisualMaterial* get_scripted_object() {return m_scripted_object;}

protected:

        diguyAuthorVisualMaterial(void* internal_data);

        bdiGeometryVisualMaterial* m_scripted_object;

        friend class bdiGeometryVisualMaterial;
        friend class bdiGeometryFactory;
};

#endif /* __diguyAuthorVisualMaterial_H */