nv::index::IScene_element Class Reference

The interface class represents scene elements. More...

#include <iscene_element.h>

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

Public Member Functions
virtual void	set_enabled (bool enable)=0
	Enable or disable a scene element for inclusion in rendering. More...
virtual bool	get_enabled () const =0
	Retrieve if a scene element is enabled or disabled from rendering. More...
virtual void	set_meta_data (mi::neuraylib::Tag_struct tag)=0
	Add metadata to a scene element. More...
virtual mi::neuraylib::Tag_struct	get_meta_data () const =0
	Retrieve the scene element's reference to user-defined metadata. More...

Detailed Description

The interface class represents scene elements.

Implementations of the interface class represent, for example, shapes and attributes in the scene. An IScene_element is a part of the scene description.

Member Function Documentation

get_enabled()

virtual bool nv::index::IScene_element::get_enabled ( ) const

pure virtual

Retrieve if a scene element is enabled or disabled from rendering.

Returns

Returns true if the rendering is enabled and false otherwise

get_meta_data()

virtual mi::neuraylib::Tag_struct nv::index::IScene_element::get_meta_data ( ) const

pure virtual

Retrieve the scene element's reference to user-defined metadata.

Returns

Returns the tag that refers to the user-defined metadata associated with the scene element

set_enabled()

virtual void nv::index::IScene_element::set_enabled ( bool  enable )

pure virtual

Enable or disable a scene element for inclusion in rendering.

Every scene element, as part of the hierarchical scene description, can be individually included (enabled) in the scene to be rendered or excluded (disabled) from the scene to be rendered. An excluded scene element will not be rendered by any renderer but remains part of scene description and can be queried and processed by means of computing tasks.

Parameters

[in]

enable

Enable (true) or disable (false) the scene element in the scene description.

set_meta_data()

virtual void nv::index::IScene_element::set_meta_data ( mi::neuraylib::Tag_struct  tag )

pure virtual

Add metadata to a scene element.

Each scene element can store additional user-defined metadata. Metadata may include, for example, a string representing the scene element's name or domain-specific attributes. A class that represents metadata has to be a database element. The scene element refers to this database element by means of a tag.

Parameters

[in]

tag

The tag that refers to the user-defined metadata associated with the scene element.

---

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

• iscene_element.h