nv::index::IEllipsoid Class Reference

The set of higher-level 3D shapes part of the NVIDIA IndeX library include a 3D ellipsoid. More...

#include <iellipsoid.h>

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

Public Member Functions
virtual const mi::math::Vector_struct< mi::Float32, 3 > &	get_center () const =0
	The center of the ellipsoid. More...
virtual void	set_center (const mi::math::Vector_struct< mi::Float32, 3 > &center)=0
	Set the center of the ellipsoid. More...
virtual void	get_semi_axes (mi::math::Vector_struct< mi::Float32, 3 > &a, mi::math::Vector_struct< mi::Float32, 3 > &b, mi::math::Vector_struct< mi::Float32, 3 > &c) const =0
	Returns the semi-axes of the ellipsoid. More...
virtual bool	set_semi_axes (const mi::math::Vector_struct< mi::Float32, 3 > &a, const mi::math::Vector_struct< mi::Float32, 3 > &b, mi::Float32 c)=0
	Sets the semi-axes of the ellipsoid. More...

Detailed Description

The set of higher-level 3D shapes part of the NVIDIA IndeX library include a 3D ellipsoid.

A 3D ellipsoid is defined by its center and three orthogonal radii. The center and radii are defined in the ellipsoid's local coordinate system. The surface of the ellipsoid is shaded using the material and light defined in the scene description.

Member Function Documentation

get_center()

virtual const mi::math::Vector_struct< mi::Float32, 3 > & nv::index::IEllipsoid::get_center ( ) const

pure virtual

The center of the ellipsoid.

Returns

The center of the ellipsoid.

get_semi_axes()

virtual void nv::index::IEllipsoid::get_semi_axes ( mi::math::Vector_struct< mi::Float32, 3 > &  a, mi::math::Vector_struct< mi::Float32, 3 > &  b, mi::math::Vector_struct< mi::Float32, 3 > &  c  ) const

pure virtual

Returns the semi-axes of the ellipsoid.

The three semi-axes must be orthogonal. Therefore, for the c-axis only the length needs to be specified here, while the direction will be computed internally.

Parameters

[out]	a	The axis of the ellipsoid in x direction.
[out]	b	The axis of the ellipsoid in y direction.
[out]	c	The axis of the ellipsoid in z direction.

set_center()

virtual void nv::index::IEllipsoid::set_center ( const mi::math::Vector_struct< mi::Float32, 3 > &  center )

pure virtual

Set the center of the ellipsoid.

Parameters

center

The center of the ellipsoid.

set_semi_axes()

virtual bool nv::index::IEllipsoid::set_semi_axes ( const mi::math::Vector_struct< mi::Float32, 3 > &  a, const mi::math::Vector_struct< mi::Float32, 3 > &  b, mi::Float32  c  )

pure virtual

Sets the semi-axes of the ellipsoid.

The three semi-axes must be orthogonal. Therefore, for the c-axis only the length needs to be specified here, while the direction will be computed internally. A radius of zero for either the x-, y-, and z-direction is invalid and will be ignored..

Parameters

[in]	a	The axis of the ellipsoid in x direction.
[in]	b	The axis of the ellipsoid in y direction.
[in]	c	The axis of the ellipsoid in z direction.

Returns

true when succeeded.

---

The documentation for this class was generated from the following file:

• iellipsoid.h