This repository has been archived on 2023-10-09. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
blender-archive/source/blender/freestyle/intern/stroke/ContextFunctions.h
Campbell Barton e12c08e8d1 ClangFormat: apply to source, most of intern
Apply clang format as proposed in T53211.

For details on usage and instructions for migrating branches
without conflicts, see:

https://wiki.blender.org/wiki/Tools/ClangFormat
2019-04-17 06:21:24 +02:00

111 lines
3.5 KiB
C++

/*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef __FREESTYLE_CONTEXT_FUNCTIONS_H__
#define __FREESTYLE_CONTEXT_FUNCTIONS_H__
/** \file
* \ingroup freestyle
* \brief Functions related to context queries
* \brief Interface to access the context related information.
*/
#include "Canvas.h"
#include "../image/GaussianFilter.h"
#include "../image/Image.h"
namespace Freestyle {
//
// Context Functions definitions
//
///////////////////////////////////////////////////////////
/*! namespace containing all the Context related functions */
namespace ContextFunctions {
// GetTimeStamp
/*! Returns the system time stamp */
unsigned GetTimeStampCF();
// GetCanvasWidth
/*! Returns the canvas width */
unsigned GetCanvasWidthCF();
// GetCanvasHeight
/*! Returns the canvas height */
unsigned GetCanvasHeightCF();
// GetBorder
/*! Returns the border */
BBox<Vec2i> GetBorderCF();
// Load map
/*! Loads an image map for further reading */
void LoadMapCF(const char *iFileName,
const char *iMapName,
unsigned iNbLevels = 4,
float iSigma = 1.0f);
// ReadMapPixel
/*! Reads a pixel in a user-defined map
* \return the floating value stored for that pixel
* \param iMapName:
* The name of the map
* \param level:
* The level of the pyramid in which we wish to read the pixel
* \param x:
* The x-coordinate of the pixel we wish to read. The origin is in the lower-left corner.
* \param y:
* The y-coordinate of the pixel we wish to read. The origin is in the lower-left corner.
*/
float ReadMapPixelCF(const char *iMapName, int level, unsigned x, unsigned y);
// ReadCompleteViewMapPixel
/*! Reads a pixel in the complete view map
* \return the floating value stored for that pixel
* \param level:
* The level of the pyramid in which we wish to read the pixel
* \param x:
* The x-coordinate of the pixel we wish to read. The origin is in the lower-left corner.
* \param y:
* The y-coordinate of the pixel we wish to read. The origin is in the lower-left corner.
*/
float ReadCompleteViewMapPixelCF(int level, unsigned x, unsigned y);
// ReadOrientedViewMapPixel
/*! Reads a pixel in one of the oriented view map images
* \return the floating value stored for that pixel
* \param iOrientation:
* The number telling which orientation we want to check
* \param level:
* The level of the pyramid in which we wish to read the pixel
* \param x:
* The x-coordinate of the pixel we wish to read. The origin is in the lower-left corner.
* \param y:
* The y-coordinate of the pixel we wish to read. The origin is in the lower-left corner.
*/
float ReadDirectionalViewMapPixelCF(int iOrientation, int level, unsigned x, unsigned y);
// DEBUG
FEdge *GetSelectedFEdgeCF();
} // end of namespace ContextFunctions
} /* namespace Freestyle */
#endif // __FREESTYLE_CONTEXT_FUNCTIONS_H__