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

NVIDIA IndeX provides scene elements that enable annotating 3D scenes or implementing 3D user-interface widgets. More...

#include <icircle.h>

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

Public Types

enum  Fill_style {
  FILL_EMPTY = 0 ,
  FILL_SOLID = 1
}
 The inner part of a circle is defined to be empty or can be filled. More...
 

Public Member Functions

virtual void set_geometry (const mi::math::Vector_struct< mi::Float32, 3 > &center, mi::Float32 radius)=0
 A circle is defined by its center and a radius. More...
 
virtual void get_geometry (mi::math::Vector_struct< mi::Float32, 3 > &center, mi::Float32 &radius) const =0
 A circle is defined by its center and a radius. More...
 
virtual void set_outline_style (const mi::math::Color_struct &line_color, mi::Float32 line_width=1.5f)=0
 A circle's outline can have a style defined by the line color and a line width. More...
 
virtual void get_outline_style (mi::math::Color_struct &line_color, mi::Float32 &line_width) const =0
 A circle's outline can have a style defined by the line color and a line width. More...
 
virtual void set_fill_style (const mi::math::Color_struct &fill_color, Fill_style fill_style)=0
 The inner part of a circle can be filled using a fill color or may be empty. More...
 
virtual void get_fill_style (mi::math::Color_struct &fill_color, Fill_style &fill_style) const =0
 The inner part of a circle can be filled using a fill color or may be empty. More...
 

Detailed Description

NVIDIA IndeX provides scene elements that enable annotating 3D scenes or implementing 3D user-interface widgets.

The annotations and widgets should be composed as part of the scene description. Such additional scene elements, which include for instance the following 2D circle, integrate seamlessly into the regular 3D large-scale data rendering, i.e., the depth-correct rendering of all opaque of semi-transparent elements is ensured by NVIDIA IndeX rendering. A 2D circle represents a screen-space shape commonly used to annotating a scene or to build widgets. The circle is defined in image space, i.e., a circle is parallel to the view plane and always faces towards the viewer.

Member Enumeration Documentation

◆ Fill_style

enum nv::index::ICircle::Fill_style

The inner part of a circle is defined to be empty or can be filled.

The fill style defines the appearance of the circle's interior.

Enumerator
FILL_EMPTY 

No fill applied to the circle.

FILL_SOLID 

The circle will be filled using a solid color.

Member Function Documentation

◆ get_fill_style()

virtual void nv::index::ICircle::get_fill_style ( mi::math::Color_struct &  fill_color,
Fill_style &  fill_style 
) const
pure virtual

The inner part of a circle can be filled using a fill color or may be empty.

The following method allows getting the fill style and sets the solid fill color.

Parameters
[out]fill_colorThe color of the circle's fill color.
[out]fill_styleThe circle's fill style.

◆ get_geometry()

virtual void nv::index::ICircle::get_geometry ( mi::math::Vector_struct< mi::Float32, 3 > &  center,
mi::Float32 &  radius 
) const
pure virtual

A circle is defined by its center and a radius.

The radius is always defined in screen space and given in pixels while the center of a circle is defined by a 3D coordinate. The following method gets the center of the circle as well as its screen space radius by reference.

Parameters
[out]centerThe center of the circle defined in the circles local 3D space.
[out]radiusThe radius in screen space defined in pixels.

◆ get_outline_style()

virtual void nv::index::ICircle::get_outline_style ( mi::math::Color_struct &  line_color,
mi::Float32 &  line_width 
) const
pure virtual

A circle's outline can have a style defined by the line color and a line width.

The following method gets the line color and the width in screen space.

Parameters
[out]line_colorThe color of the circle's outline.
[out]line_widthThe width of the circle's outline defined in pixels.

◆ set_fill_style()

virtual void nv::index::ICircle::set_fill_style ( const mi::math::Color_struct &  fill_color,
Fill_style  fill_style 
)
pure virtual

The inner part of a circle can be filled using a fill color or may be empty.

The following method allows setting the fill style and sets the solid fill color.

Parameters
[in]fill_colorThe color of the circle's fill color
[in]fill_styleThe circle's fill style.

◆ set_geometry()

virtual void nv::index::ICircle::set_geometry ( const mi::math::Vector_struct< mi::Float32, 3 > &  center,
mi::Float32  radius 
)
pure virtual

A circle is defined by its center and a radius.

The radius is always defined in screen space and given in pixels while the center of a circle is defined by a 3D coordinate. The following method sets the center of the circle as well as its screen space radius.

Parameters
[in]centerThe center of the circle defined in the circles local 3D space.
[in]radiusThe radius in screen space defined in pixels.

◆ set_outline_style()

virtual void nv::index::ICircle::set_outline_style ( const mi::math::Color_struct &  line_color,
mi::Float32  line_width = 1.5f 
)
pure virtual

A circle's outline can have a style defined by the line color and a line width.

The following method sets the line color and the width in screen space.

Parameters
[in]line_colorThe color of the circle's outline.
[in]line_widthThe width of the circle's outline defined in pixels.
The documentation for this class was generated from the following file: