nv::index::IDiagnostic_rendering_properties Class Reference

Interface representing rendering properties for diagnostic rendering. More...

#include <idiagnostic_rendering_properties.h>

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

Public Types
enum	Property {   MODE ,   OPACITY ,   OPACITY_FRONT ,   OPACITY_BACK ,   WIRE_SIZE ,   SMOOTHING ,   ITEM_LIMIT ,   ITEM_START ,   FRAME_CYCLE ,   HOST_ID ,   DEVICE_ID }
	Property identifiers. More...
enum	Property_type {   INVALID_TYPE ,   SIGNED_INT32 ,   UNSIGNED_INT32 ,   FLOAT32 }
	Underlying datatype of a property. More...

Public Member Functions
virtual bool	set_property (mi::Sint32 prop, mi::Float64 value)=0
	Setting a property. More...
virtual mi::Float64	get_property (mi::Sint32 prop) const =0
	Getting a property. More...
virtual mi::Uint32	get_property_count () const =0
	Get the number of the set property values. More...
virtual Property_type	get_property_type (mi::Sint32 prop) const =0
	Getting a property type for a property identifier. More...
virtual const char *	get_property_name (mi::Sint32 prop) const =0
	Getting a property type as string for a property identifier. More...

Detailed Description

Interface representing rendering properties for diagnostic rendering.

Member Enumeration Documentation

Property

enum nv::index::IDiagnostic_rendering_properties::Property

Property identifiers.

Enumerator
MODE	[uint] (0) Render mode 0:off, 1:subregions + scene, 2:subregions only
OPACITY	[float] (0.25) Opacity of surfaces of subregion boxes.
OPACITY_FRONT	[float] (1) Opacity factor of front (near) surfaces of subregion boxes.
OPACITY_BACK	[float] (1) Opacity factor of back (far) surfaces of subregion boxes.
WIRE_SIZE	[float] (1) Size of wireframe line, in pixels.
SMOOTHING	[float] (1) Smoothing range of wireframe line, 0 == no smoothing.
ITEM_LIMIT	[int] (0) Limit number of subregions rendered (per device), 0 == unlimited. If negative, then animate limit range from 1 to value, using FRAME_CYCLE.
ITEM_START	[int] (0) Index of first subregion rendered (per device).
FRAME_CYCLE	[int] (0) Switch ITEM_LIMIT after number of frames, when animating ITEM_LIMIT.
HOST_ID	[int] (-1) Restrict rendering to given host id, -1 == all hosts.
DEVICE_ID	[int] (-1) Restrict rendering to given device id, -1 == all devices.

Property_type

enum nv::index::IDiagnostic_rendering_properties::Property_type

Underlying datatype of a property.

Enumerator
INVALID_TYPE	! Undefined/invalid type
SIGNED_INT32	! Signed 32-bit integer type.
UNSIGNED_INT32	! Unsigned 32-bit integer type.
FLOAT32	! 32-bit floating-point type.

Member Function Documentation

get_property()

virtual mi::Float64 nv::index::IDiagnostic_rendering_properties::get_property ( mi::Sint32  prop ) const

pure virtual

Getting a property.

Parameters

[in]

prop

The property identifier.

Returns

Returns value for the given property identifier.

get_property_count()

virtual mi::Uint32 nv::index::IDiagnostic_rendering_properties::get_property_count ( ) const

pure virtual

Get the number of the set property values.

Returns

Returns number of properties.

get_property_name()

virtual const char * nv::index::IDiagnostic_rendering_properties::get_property_name ( mi::Sint32  prop ) const

pure virtual

Getting a property type as string for a property identifier.

Parameters

[in]

prop

The property identifier.

Returns

Returns the property type as string.

get_property_type()

virtual Property_type nv::index::IDiagnostic_rendering_properties::get_property_type ( mi::Sint32  prop ) const

pure virtual

Getting a property type for a property identifier.

Parameters

[in]

prop

The property identifier.

Returns

Returns the property type.

set_property()

virtual bool nv::index::IDiagnostic_rendering_properties::set_property ( mi::Sint32  prop, mi::Float64  value  )

pure virtual

Setting a property.

Parameters

[in]	prop	The property identifier.
[in]	value	The value to be set along with the property.

Returns

Returns success.

---

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

• idiagnostic_rendering_properties.h