Forge: surface.h Source File

Forge

- Main Page
- Namespaces
- Data Structures
- Files

- File List
- Globals

surface.h
Go to the documentation of this file.
1 /*******************************************************
2 * Copyright (c) 2015-2019, ArrayFire
3 * All rights reserved.
4 *
5 * This file is distributed under 3-clause BSD license.
6 * The complete license agreement can be obtained at:
7 * http://arrayfire.com/licenses/BSD-3-Clause
8 ********************************************************/
9
10 #pragma once
11
12 #include <fg/defines.h>
13
14 namespace internal
15 {
16 class _Surface;
17 }
18
19 namespace fg
20 {
21
27 class Surface {
28 private:
29 internal::_Surface* value;
30
31 public:
40 FGAPI Surface(unsigned pNumXPoints, unsigned pNumYPoints, dtype pDataType, PlotType pPlotType=fg::FG_SURFACE, MarkerType pMarkerType=fg::FG_NONE);
41
47 FGAPI Surface(const Surface& other);
48
52 FGAPI ~Surface();
53
59 FGAPI void setColor(fg::Color col);
60
68 FGAPI void setColor(float pRed, float pGreen, float pBlue);
69
78 FGAPI void setAxesLimits(float pXmax, float pXmin, float pYmax, float pYmin, float pZmax, float pZmin);
79
87 FGAPI void setAxesTitles(const char* pXTitle, const char* pYTitle, const char* pZTitle);
88
94 FGAPI float xmax() const;
95
101 FGAPI float xmin() const;
102
108 FGAPI float ymax() const;
109
115 FGAPI float ymin() const;
116
122 FGAPI float zmax() const;
123
129 FGAPI float zmin() const;
130
136 FGAPI unsigned vbo() const;
137
143 FGAPI unsigned size() const;
144
148 FGAPI internal::_Surface* get() const;
149 };
150
151 }
fg::FG_SURFACE
Definition: defines.h:144
fg::Surface::xmin
FGAPI float xmin() const
Get X-Axis minimum value.
fg
Definition: CPUCopy.hpp:13
fg::Surface::Surface
FGAPI Surface(unsigned pNumXPoints, unsigned pNumYPoints, dtype pDataType, PlotType pPlotType=fg::FG_SURFACE, MarkerType pMarkerType=fg::FG_NONE)
Creates a Surface object.
fg::Surface::zmax
FGAPI float zmax() const
Get Z-Axis maximum value.
FGAPI
#define FGAPI
Definition: defines.h:32
defines.h
fg::Surface::~Surface
FGAPI ~Surface()
Plot Destructor.
fg::dtype
dtype
Definition: defines.h:131
fg::PlotType
PlotType
Definition: defines.h:141
fg::MarkerType
MarkerType
Definition: defines.h:147
fg::Surface::setAxesTitles
FGAPI void setAxesTitles(const char *pXTitle, const char *pYTitle, const char *pZTitle)
Set axes titles.
internal
Definition: font.h:13
fg::Surface::ymin
FGAPI float ymin() const
Get Y-Axis minimum value.
fg::Surface::xmax
FGAPI float xmax() const
Get X-Axis maximum value.
fg::FG_NONE
Definition: defines.h:148
fg::Surface::setColor
FGAPI void setColor(fg::Color col)
Set the color of line graph(plot)
fg::Surface::size
FGAPI unsigned size() const
Get the OpenGL Vertex Buffer Object resource size.
fg::Surface::ymax
FGAPI float ymax() const
Get Y-Axis maximum value.
fg::Surface::zmin
FGAPI float zmin() const
Get Z-Axis minimum value.
fg::Surface::setAxesLimits
FGAPI void setAxesLimits(float pXmax, float pXmin, float pYmax, float pYmin, float pZmax, float pZmin)
Set the chart axes limits.
fg::Surface
3d graph to display plots.
Definition: surface.h:27
fg::Color
Color
Definition: defines.h:120
fg::Surface::vbo
FGAPI unsigned vbo() const
Get the OpenGL Vertex Buffer Object identifier.