NVIDIA IndeX API nvidia_logo_transpbg.gif Up
Public Member Functions | List of all members
nv::index::IIcon_2D Class Referenceabstract
NVIDIA IndeX API » Scene description » Basic Shapes

Icons are common means for annotating a 3D scene using images. More...

#include <iicon.h>

Inherits mi::base::Interface_declare< 0xfea64c6d, ... >.

Public Member Functions

virtual void set_geometry (const mi::math::Vector_struct< mi::Float32, 3 > &position, const mi::math::Vector_struct< mi::Float32, 2 > &right_vector, const mi::math::Vector_struct< mi::Float32, 2 > &up_vector, mi::Float32 height, mi::Float32 width=-1.0f)=0
 The position of the icon is defined in its local coordinate system by the anchor point that lies inside the plane that the icon lies in and defines the icon's lower left corner. More...
 
virtual void get_geometry (mi::math::Vector_struct< mi::Float32, 3 > &position, mi::math::Vector_struct< mi::Float32, 2 > &right_vector, mi::math::Vector_struct< mi::Float32, 2 > &up_vector, mi::Float32 &height, mi::Float32 &width) const =0
 The position of the icon is defined in its local coordinate system by the anchor point that lies inside plane that the icon lies in and defines the icon's lower left corner. More...
 

Detailed Description

Icons are common means for annotating a 3D scene using images.

The 2D icon is defined in image space and always faces towards the viewer, similar to a billboard; the label is parallel to the view plane. The size is defined in 2D image space (screen space) in pixel.

Member Function Documentation

◆ get_geometry()

virtual void nv::index::IIcon_2D::get_geometry ( mi::math::Vector_struct< mi::Float32, 3 > &  position,
mi::math::Vector_struct< mi::Float32, 2 > &  right_vector,
mi::math::Vector_struct< mi::Float32, 2 > &  up_vector,
mi::Float32 &  height,
mi::Float32 &  width 
) const
pure virtual

The position of the icon is defined in its local coordinate system by the anchor point that lies inside plane that the icon lies in and defines the icon's lower left corner.

The orientation of the icon is defined by a right and an up vector. Both these vectors are defined in 2D image space.

Parameters
[out]positionThe position defines the lower left corner of the icon.
[out]right_vectorThe right vector of the icon together with the up vector defines the orientation of the icon in 2D space.
[out]up_vectorThe up vector of the icon together with the right vector defines the orientation of the icon in 2D space.
[in]heightThe height of the icon along the up vector in image space, pixel.
[in]widthThe width of the icon along the right vector in image space, pixel.

◆ set_geometry()

virtual void nv::index::IIcon_2D::set_geometry ( const mi::math::Vector_struct< mi::Float32, 3 > &  position,
const mi::math::Vector_struct< mi::Float32, 2 > &  right_vector,
const mi::math::Vector_struct< mi::Float32, 2 > &  up_vector,
mi::Float32  height,
mi::Float32  width = -1.0f 
)
pure virtual

The position of the icon is defined in its local coordinate system by the anchor point that lies inside the plane that the icon lies in and defines the icon's lower left corner.

The orientation of the icon is defined by a right and an up vector. Both these vectors are defined in 2D image space.

Parameters
[in]positionThe position defines the lower left corner of the icon.
[in]right_vectorThe right vector of the icon together with the up vector defines the orientation of the icon in 2D image space.
[in]up_vectorThe up vector of the icon together with the right vector defines the orientation of the icon in 2D image space.
[in]heightThe height of the icon along the up vector in image space, pixel.
[in]widthThe width of the icon along the right vector in image space, pixel. If the width is not set (or set a negative value) then the width of the icon will be computed by the rendering system.
The documentation for this class was generated from the following file: