NVIDIA IndeX API nvidia_logo_transpbg.gif Up
nv::index::xac::Ellipsoid Class Reference

Ellipsoid. More...

#include <xac_interface_scene_elements_doc.h>

Public Types

typedef Sample_info_surface Base_info_type
 Declaration of the surface type info. More...
 

Public Member Functions

uint get_light_id () const
 Retrieve associated scene light id. More...
 
uint get_material_id () const
 Retrieve associated scene material id. More...
 
bool is_valid () const
 Check if the properties of the current shape are valid. More...
 
bool is_inside (const float3 &scene_position) const
 Check if a given position in scene space coordinates is inside the ellipsoid. More...
 
float get_distance (const float3 &scene_position) const
 Compute the signed distance to the ellipsoid boundary surface. More...
 
const float3 & get_center () const
 Get the ellipsoid center position in scene space coordinates. More...
 
const float3 get_semi_axis_a () const
 Get the semi axis a of the ellipsoid. More...
 
const float3 get_semi_axis_b () const
 Get the semi axis b of the ellipsoid. More...
 
const float3 get_semi_axis_c () const
 Get the semi axis c of the ellipsoid. More...
 
const Mat3x3f & get_world_to_axis_transform () const
 Get the axis transformation matrix for the ellipsoid. More...
 
const Mat3x3f & get_world_to_axis_transform_inverse () const
 Get the inverse axis transformation matrix for the ellipsoid. More...
 

Detailed Description

Member Typedef Documentation

 Base_info_type

Declaration of the surface type info.

Member Function Documentation

 get_center()

const float3 & nv::index::xac::Ellipsoid::get_center ( ) const

Get the ellipsoid center position in scene space coordinates.

 get_distance()

float nv::index::xac::Ellipsoid::get_distance ( const float3 &  scene_position) const

Compute the signed distance to the ellipsoid boundary surface.

 get_light_id()

uint nv::index::xac::Ellipsoid::get_light_id ( ) const

Retrieve associated scene light id.

 get_material_id()

uint nv::index::xac::Ellipsoid::get_material_id ( ) const

Retrieve associated scene material id.

 get_semi_axis_a()

const float3 nv::index::xac::Ellipsoid::get_semi_axis_a ( ) const

Get the semi axis a of the ellipsoid.

 get_semi_axis_b()

const float3 nv::index::xac::Ellipsoid::get_semi_axis_b ( ) const

Get the semi axis b of the ellipsoid.

 get_semi_axis_c()

const float3 nv::index::xac::Ellipsoid::get_semi_axis_c ( ) const

Get the semi axis c of the ellipsoid.

 get_world_to_axis_transform()

const Mat3x3f & nv::index::xac::Ellipsoid::get_world_to_axis_transform ( ) const

Get the axis transformation matrix for the ellipsoid.

 get_world_to_axis_transform_inverse()

const Mat3x3f & nv::index::xac::Ellipsoid::get_world_to_axis_transform_inverse ( ) const

Get the inverse axis transformation matrix for the ellipsoid.

 is_inside()

bool nv::index::xac::Ellipsoid::is_inside ( const float3 &  scene_position) const

Check if a given position in scene space coordinates is inside the ellipsoid.

 is_valid()

bool nv::index::xac::Ellipsoid::is_valid ( ) const

Check if the properties of the current shape are valid.


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