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

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

#include <iellipse.h>

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

Public Types

enum  Fill_style {
  FILL_EMPTY = 0 ,
  FILL_SOLID = 1
}
 The inner part of an ellipse 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_x, mi::Float32 radius_y, mi::Float32 rotation=0.f)=0
 An ellipse is defined by its center and two radii plus a rotation in screen space. More...
 
virtual void get_geometry (mi::math::Vector_struct< mi::Float32, 3 > &center, mi::Float32 &radius_x, mi::Float32 &radius_y, mi::Float32 &rotation) const =0
 An ellipse is defined by its center and two radii plus a rotation in screen space. More...
 
virtual void set_outline_style (const mi::math::Color_struct &line_color, mi::Float32 line_width=1.5f)=0
 An ellipse'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
 An ellipse'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 ellipse 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 ellipse 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 ellipse, 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 ellipse represents a screen-space shape commonly used to annotating a scene or to build widgets. The ellipse is defined in image space, i.e., an ellipse is parallel to the view plane and always faces towards the viewer.

Member Enumeration Documentation

◆ Fill_style

enum nv::index::IEllipse::Fill_style

The inner part of an ellipse is defined to be empty or can be filled.

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

Enumerator
FILL_EMPTY 

No fill applied to the ellipse.

FILL_SOLID 

The ellipse will be filled using a solid color.

Member Function Documentation

◆ get_fill_style()

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

The inner part of a ellipse 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 ellipse's fill color.
[out]fill_styleThe ellipse's fill style.

◆ get_geometry()

virtual void nv::index::IEllipse::get_geometry ( mi::math::Vector_struct< mi::Float32, 3 > &  center,
mi::Float32 &  radius_x,
mi::Float32 &  radius_y,
mi::Float32 &  rotation 
) const
pure virtual

An ellipse is defined by its center and two radii plus a rotation in screen space.

The radii are always defined in screen space and given in pixels while the center of an ellipse is defined by a 3D coordinate. The rotation is a counter clock-wise rotation in screen space defined by an angle in radians. The following method gets the center of the ellipse as well as its screen space radii and rotation.

Parameters
[out]centerThe center position of the ellipse defined in the ellipses local 3D space.
[out]radius_xThe radius in pixels along ellipse's x (horizontal) axis.
[out]radius_yThe radius in pixels along ellipse's y (vertical) axis.
[out]rotationThe rotation angle in radians around it's center counter clock wise.

◆ get_outline_style()

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

An ellipse'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 ellipse's outline.
[out]line_widthThe width of the ellipse's outline defined in pixels.

◆ set_fill_style()

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

The inner part of a ellipse 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 ellipse's fill color.
[in]fill_styleThe ellipse's fill style.

◆ set_geometry()

virtual void nv::index::IEllipse::set_geometry ( const mi::math::Vector_struct< mi::Float32, 3 > &  center,
mi::Float32  radius_x,
mi::Float32  radius_y,
mi::Float32  rotation = 0.f 
)
pure virtual

An ellipse is defined by its center and two radii plus a rotation in screen space.

The radii are always defined in screen space and given in pixels while the center of an ellipse is defined by a 3D coordinate. The rotation is a counter clock-wise rotation in screen space defined by an angle in radians. The following method sets the center of the ellipse as well as its screen space radii and rotation.

Parameters
[in]centerThe center position of the ellipse defined in the ellipses local 3D space.
[in]radius_xThe radius in pixels along ellipse's x (horizontal) axis.
[in]radius_yThe radius in pixels along ellipse's y (vertical) axis.
[in]rotationThe rotation angle in radians around it's center counter clock wise.

◆ set_outline_style()

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

An ellipse'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 ellipse's outline.
[in]line_widthThe width of the ellipse's outline defined in pixels.
The documentation for this class was generated from the following file: