SLDrawBits.h

Go to the documentation of this file.

/**
 * \file      sl/SLDrawBits.h
 * \date      July 2014
 * \authors   Marcus Hudritsch
 * \copyright http://opensource.org/licenses/GPL-3.0
 * \remarks   Please use clangformat to format the code. See more code style on
 *            https://github.com/cpvrlab/SLProject4/wiki/SLProject-Coding-Style
*/
 
#ifndef SLDRAWBITS_H
#define SLDRAWBITS_H
 
#include <SL.h>
 
//-----------------------------------------------------------------------------
/*!
Drawing Bits control some visual states of the scene and are applied per scene
view or per single node object. Not all are used from the beginning
*/
#define SL_DB_HIDDEN 1          //!< Flags an object as hidden
#define SL_DB_NOTSELECTABLE 2   //!< Flags an object as selected
#define SL_DB_MESHWIRED 4       //!< Draw polygons as wired mesh
#define SL_DB_NORMALS 8         //!< Draw the vertex normals
#define SL_DB_BBOX 16           //!< Draw the bounding boxes of a node
#define SL_DB_AXIS 32           //!< Draw the coordinate axis of a node
#define SL_DB_VOXELS 64         //!< Draw the voxels of the uniform grid
#define SL_DB_SKELETON 128      //!< Draw the skeletons joints
#define SL_DB_CULLOFF 256       //!< Turn off face culling
#define SL_DB_OVERDRAW 512      //!< Draw node over all other nodes
#define SL_DB_WITHEDGES 1024    //!< Draw faces with hard edges
#define SL_DB_ONLYEDGES 2048    //!< Draw only hard edges
#define SL_DB_BRECT 4096        //!< Draw the bounding rectangle of a node
#define SL_DB_GPU_SKINNING 8192 //!< Perform skinning on the GPU
 
//-----------------------------------------------------------------------------
//! Drawing states stored in the bits of an unsigned int
/*! The drawing bits can be applied to the entire scene, a group or a mesh. The
default value is 0 signifying the default state. See the defines above for the
different drawing bit flags.
*/
class SLDrawBits
{
public:
    SLDrawBits() { _bits = 0; }
    ~SLDrawBits() { ; }
 
    //! Turns all bits off
    void allOff() { _bits = 0; }
 
    //! Turns the specified bit on
    void on(SLuint bit) { SL_SETBIT(_bits, bit); }
 
    //! Turns the specified bit off
    void off(SLuint bit) { SL_DELBIT(_bits, bit); }
 
    //! Sets the specified bit to the passed state
    void set(SLuint bit, SLbool state)
    {
        if (state)
            SL_SETBIT(_bits, bit);
        else
            SL_DELBIT(_bits, bit);
    }
 
    //! Toggles the specified bit
    void toggle(SLuint bit) { SL_TOGBIT(_bits, bit); }
 
    //! Returns the specified bit
    SLbool get(SLuint bit) { return (_bits & bit) ? true : false; }
 
    //! Returns the all bits
    SLuint bits() { return _bits; }
 
    //! Set all bits
    void bits(SLuint b) { _bits = b; }
 
private:
    SLuint _bits; //!< Drawing flags as a unsigned 32-bit register
};
//-----------------------------------------------------------------------------
#endif