Render3D
interface.
- See also
- NVXIO APIs
Definition at line 59 of file Render3D.hpp.
|
enum | MouseButtonEvent {
LeftButtonDown,
LeftButtonUp,
MiddleButtonDown,
MiddleButtonUp,
RightButtonDown,
RightButtonUp,
MouseMove
} |
| Defines mouse events. More...
|
|
typedef void(* | OnKeyboardEventCallback )(void *context, vx_char key, vx_uint32 x, vx_uint32 y) |
| Callback for keyboard events. More...
|
|
typedef void(* | OnMouseEventCallback )(void *context, MouseButtonEvent event, vx_uint32 x, vx_uint32 y) |
| Callback for mouse events. More...
|
|
enum | TargetType {
UNKNOWN_RENDER,
BASE_RENDER_3D
} |
| Defines Render3D types. More...
|
|
Callback for keyboard events.
- Parameters
-
[in] | context | A pointer to data to be passed to the callback. |
[in] | key | Specifies the keyboard key that corresponds to the event. |
[in] | x | Specifies the x-coordinate of the mouse position. |
[in] | y | Specifies the y-coordinate of the mouse position. |
Definition at line 119 of file Render3D.hpp.
Callback for mouse events.
- Parameters
-
[in] | context | A pointer to data to be passed to the callback. |
[in] | event | Specifies the mouse event. |
[in] | x | Specifies the x-coordinate of the mouse position. |
[in] | y | Specifies the y-coordinate of the mouse position. |
Definition at line 127 of file Render3D.hpp.
Defines Render3D
types.
Enumerator |
---|
UNKNOWN_RENDER |
Indicates a stub render.
|
BASE_RENDER_3D |
Indicates Render3D.
|
Definition at line 66 of file Render3D.hpp.
Defines mouse events.
Enumerator |
---|
LeftButtonDown |
Indicates the left mouse button has been pressed down.
|
LeftButtonUp |
Indicates the left mouse button has been released.
|
MiddleButtonDown |
Indicates a middle mouse button has been pressed down.
|
MiddleButtonUp |
Indicates the middle mouse button has been released.
|
RightButtonDown |
Indicates the right mouse button has been pressed down.
|
RightButtonUp |
Indicates the right mouse button has been released.
|
MouseMove |
Indicates the mouse has been moved.
|
Definition at line 101 of file Render3D.hpp.
virtual nvxio::Render3D::~Render3D |
( |
| ) |
|
|
inlinevirtual |
Sets the keyboard event callback.
- Parameters
-
[in] | callback | Specifies the callback to set. |
[in] | context | A pointer to data to be passed to the callback. |
virtual void nvxio::Render3D::setOnMouseEventCallback |
( |
OnMouseEventCallback |
callback, |
|
|
void * |
context |
|
) |
| |
|
pure virtual |
Sets mouse event callback.
- Parameters
-
[in] | callback | Callback. |
[in] | context | A pointer to data to be passed to the callback. |
Puts the surface to the render.
The surface consists of 2 adjacent triangles.
- Parameters
-
[in] | planes | Array of surface. The surface is encoded as 4 nvx_point3f_t points that define the vertices of the triangles. If the points are (p1,p2,p3,p4), then (p1,p2,p3) define the first triangle and (p1,p3,p4) define the second. |
[in] | model | Specifies the model matrix that transforms Model Space to World Space coordinates. |
[in] | style | A reference to the style of the surface. |
Puts the point cloud to the render.
- Parameters
-
[in] | points | Array of the points. The point is encoded as nvx_point3f_t. |
[in] | model | Specifies the model matrix that transforms Model Space to World Space coordinates. |
[in] | style | A reference to the style of the point cloud. |
virtual bool nvxio::Render3D::flush |
( |
| ) |
|
|
pure virtual |
Renders all primitives.
- Returns
- Status of the operation.
virtual void nvxio::Render3D::close |
( |
| ) |
|
|
pure virtual |
virtual void nvxio::Render3D::setViewMatrix |
( |
vx_matrix |
view | ) |
|
|
pure virtual |
Sets view matrix.
The view matrix transforms World Space to Camera Space coordinates.
- Parameters
-
[in] | view | Specifies the view matrix. |
virtual void nvxio::Render3D::getViewMatrix |
( |
vx_matrix |
view | ) |
const |
|
pure virtual |
Gets view matrix.
The view matrix transforms World Space to Camera Space coordinates.
- Parameters
-
[out] | view | Returns the view matrix. |
virtual void nvxio::Render3D::setProjectionMatrix |
( |
vx_matrix |
projection | ) |
|
|
pure virtual |
Sets the projection matrix.
The projection matrix transforms Camera Space to Homogeneous Space coordinates.
- Parameters
-
[in] | projection | Specifies the projection matrix. |
virtual void nvxio::Render3D::getProjectionMatrix |
( |
vx_matrix |
projection | ) |
const |
|
pure virtual |
Gets the projection matrix.
The projection matrix transforms Camera Space to Homogeneous Space coordinates.
- Parameters
-
[out] | projection | Returns the projection matrix. |
virtual void nvxio::Render3D::setDefaultFOV |
( |
float |
fov | ) |
|
|
pure virtual |
Sets the field of view.
- Parameters
-
[in] | fov | Specifies the field of view in degrees. |
virtual void nvxio::Render3D::enableDefaultKeyboardEventCallback |
( |
| ) |
|
|
pure virtual |
Enables the default keyboard event handler.
In this case the user can handle the camera by pressing W
, S
, A
, D
, -
, +
buttons. W
/S
- pitch, A
/D
- yaw, -
/=
- zoom.
virtual void nvxio::Render3D::disableDefaultKeyboardEventCallback |
( |
| ) |
|
|
pure virtual |
Disables default keyboard event handler.
virtual bool nvxio::Render3D::useDefaultKeyboardEventCallback |
( |
| ) |
|
|
pure virtual |
Gets the flag indicating if the default keyboard event handler is enabled.
- Returns
true
indicates enabled; false
indicates disabled.
virtual vx_uint32 nvxio::Render3D::getWidth |
( |
| ) |
const |
|
pure virtual |
Gets the width.
- Returns
- The width.
virtual vx_uint32 nvxio::Render3D::getHeight |
( |
| ) |
const |
|
pure virtual |
Gets the height.
- Returns
- The height.
virtual void nvxio::Render3D::putImage |
( |
vx_image |
image | ) |
|
|
pure virtual |
Puts the image to the render.
- Parameters
-
[in] | image | Specifies the image. |
Puts a message box on the image.
- Parameters
-
[in] | text | A reference to the text of the message. |
[in] | style | A reference to the style of the message box. |
const std::string nvxio::Render3D::renderName |
|
protected |
The documentation for this class was generated from the following file: