NDEVR
API Documentation
ViewLocation.h
1/*--------------------------------------------------------------------------------------------
2Copyright (c) 2019, NDEVR LLC
3tyler.parke@ndevr.org
4 __ __ ____ _____ __ __ _______
5 | \ | | | __ \ | ___|\ \ / / | __ \
6 | \ | | | | \ \ | |___ \ \ / / | |__) |
7 | . \| | | |__/ / | |___ \ V / | _ /
8 | |\ |_|_____/__|_____|___\_/____| | \ \
9 |__| \__________________________________| \__\
10
11Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
12Licensee a limited, non-exclusive, non-transferable, royalty-free license
13(without the right to sublicense) to use the API solely for the purpose of
14Licensee's internal development efforts to develop applications for which
15the API was provided.
16
17The above copyright notice and this permission notice shall be included in all
18copies or substantial portions of the Software.
19
20THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
21INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
22PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
23FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25DEALINGS IN THE SOFTWARE.
26
27Library: Design
28File: ViewLocation
29Included in API: True
30Author(s): Tyler Parke
31 *-----------------------------------------------------------------------------------------**/
32#pragma once
33#include <NDEVR/BaseValues.h>
34namespace NDEVR
35{
72 template<> inline const SnapLocation Constant<SnapLocation>::Invalid = SnapLocation::e_no_snap;
85};
86
87
88
89
The primary namespace for the NDEVR SDK.
@ e_right
Align text to the right.
Definition Font.h:320
@ e_left
Align text to the left.
Definition Font.h:319
@ e_undefined
Role not yet defined.
SnapLocation
A list of directions that a view can be pointed relative to an object or scene.
@ e_front
Front-facing view relative to the object.
@ e_back_wo_pitch_yaw
Back-facing view with both pitch and yaw locked.
@ e_w_side_snap
Side view from the west.
@ e_bottom_snap
Bottom view looking straight up.
@ e_isometric_ne
Isometric view from the northeast.
@ e_isometric_s
Isometric view from the south.
@ e_isometric_w
Isometric view from the west.
@ e_no_snap
No snap applied; free camera orientation.
@ e_s_side_snap
Side view from the south.
@ e_n_side_snap
Side view from the north.
@ e_back
Back-facing view relative to the object.
@ e_isometric_nw
Isometric view from the northwest.
@ e_right_wo_yaw
Right-side view with yaw locked (no yaw rotation).
@ e_best_side_snap
Automatically choose the best side-on snap direction.
@ e_isometric_e
Isometric view from the east.
@ e_e_side_snap
Side view from the east.
@ e_front_wo_pitch_yaw
Front-facing view with both pitch and yaw locked.
@ e_isometric_se
Isometric view from the southeast.
@ e_isometric_sw
Isometric view from the southwest.
@ e_back_wo_pitch
Back-facing view with pitch locked (no pitch rotation).
@ e_left_wo_yaw
Left-side view with yaw locked (no yaw rotation).
@ e_isometric_n
Isometric view from the north.
@ e_top_down_snap
Top-down (plan) view looking straight down.
@ e_best_snap
Automatically choose the best snap direction.
ViewportLayoutTheme
The potential layouts of multiple viewports within the NDEVR engine.
@ e_1_panel
Single viewport panel filling the entire area.
@ e_1l1r_panel
Two panels side-by-side: one left, one right.
@ e_2l2r_panel
Four panels in a 2x2 grid: two left, two right.
@ e_1l2r_panel
Three panels: one on the left, two stacked on the right.
@ e_2l1r_panel
Three panels: two stacked on the left, one on the right.