//
// Copyright (C) 2004-2011 by Autodesk, Inc.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of version 2.1 of the GNU Lesser
// General Public License as published by the Free Software Foundation.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
//
#ifndef GRIDCOLORNULLHANDLER_H_
#define GRIDCOLORNULLHANDLER_H_
#include "GridColorHandler.h"
///
/// Class GridColorNullHandler is derived from GridColorHandler.
/// It is used to handle the situtation when there is on rule.
///
class GridColorNullHandler : public GridColorHandler
{
public:
///
/// Constructor.
///
GridColorNullHandler();
///
/// Destructor.
///
virtual ~GridColorNullHandler();
///
/// Function to initialize the GridColorNullHandler object.
///
///
/// The rules includes the detail info.
///
///
/// The grid that the styles are applied on.
///
///
/// Returns true if it is intialized successfully.
/// Othrewise, returns false.
///
virtual bool Initialize(const MdfModel::RuleCollection *pRules, const GridData *pGrid);
///
/// Function to get the color on the pixel.
/// This function alwasy return a white color.
///
///
/// [Out] Stores the result color, it is always white.
///
///
/// The X axis position of the pixel
///
///
/// The Y axis position of the pixel
///
///
/// Returns true if it gets the color.
/// Othrewise, returns false.
///
virtual bool GetColor(Color &color, unsigned int x, unsigned int y);
///
/// Function to clear the data info of the handler.
///
virtual void Clear();
};
#endif