LightObject.hh

Go to the documentation of this file.

/*===========================================================================*\
*                                                                            *
*                              OpenFlipper                                   *
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           *
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,       *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR        *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              *
*                                                                            *
\*===========================================================================*/

/*===========================================================================*\
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
\*===========================================================================*/

//=============================================================================
//
//  Types
//
//=============================================================================

#ifndef LIGHTOBJECT_HH
#define LIGHTOBJECT_HH

 

//== INCLUDES =================================================================

#include <OpenFlipper/common/BaseObjectData.hh>       
#include <OpenFlipper/common/GlobalDefines.hh>

#include "LightTypes.hh"

//== TYPEDEFS =================================================================

// //== CLASS DEFINITION =========================================================

class DLLEXPORT LightObject : public BaseObjectData {

  friend class TypeLightPlugin;
  friend class LightWidget;

  public: 
    LightObject();
    
    LightObject(const LightObject& _object);

    virtual ~LightObject();
    
    virtual void cleanup();   

    BaseObject* copy();


  protected:
    virtual void init(LightNode* _light = 0, LightNode* _lightVis = 0);

  //===========================================================================
  //===========================================================================       
  public:
    
    void setName( QString _name );
    
  //===========================================================================
  //=========================================================================== 
  public:
    
    LightSource* lightSource();
    

    bool defaultLight() const { return defaultLightSource_; }
    
    void defaultLight( const bool _default ) { defaultLightSource_ = _default; }
    
  private:
    LightSource lightSource_;
    
    bool defaultLightSource_;
    
  //===========================================================================
  //===========================================================================

  protected:
    virtual void update(UpdateType _type = UPDATE_ALL);

  //===========================================================================
  //=========================================================================== 

  public:
    LightNode* lightNode();
    
    LightNode* lightNodeVis();
    
    virtual bool hasNode(BaseNode* _node);
    
  private:
    LightNode* lightNode_;
    
    LightNode* lightNodeVis_;

  //===========================================================================
  //===========================================================================    
  public:
    QString getObjectinfo();
    
  //===========================================================================
  //===========================================================================    
  public:
    bool picked( uint _node_idx );

    void enablePicking( bool _enable );

    bool pickingEnabled();
    
  public:
    
    virtual void visible(bool _visible);
    
    virtual bool visible();
    
    virtual void show();
    
    virtual void hide();
    

};

//=============================================================================
#endif // LIGHTOBJECT_HH defined
//=============================================================================