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

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

#include <iicon.h>

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

Public Member Functions

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

Detailed Description

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

The 3D icon is defined in 3D space and its orientation is affected by the transformations applied by the scene description. The size is defined in 3D object space length.

Member Function Documentation

◆ get_geometry()

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

The position and orientation in local coordinate system is defined by an anchor point that lies inside plane the icon lies in and defines the icon's lower left corner, the right and up vectors to the icon, and the up vector.

The direction that the normal points to defines the front face of the icon that displays the image.

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 3D space.
[out]up_vectorThe up vector of the icon together with the right vector defines the orientation of the icon in 3D space.
[in]heightThe height of the icon along the up vector in the 3D object space length.
[in]widthThe width of the icon along the right vector in the 3D object space length.

◆ set_geometry()

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

The position and orientation in its local coordinate system is defined by an anchor point that lies inside the plane that the icon lies in and defines the icon's lower left corner, the normal vector perpendicular to the icon, and the up vector.

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 3D space.
[in]up_vectorThe up vector of the icon together with the right vector defines the orientation of the icon in 3D space.
[in]heightThe height of the icon along the up vector in 3D object space length.
[in]widthThe width of the icon along the right vector in 3D object space length. 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: