neuray API Programmer's Manual

mi::neuraylib::ISection_object Class Reference

[Miscellaneous]

Description

Section objects are used to cull parts of the scene. For now, planes are the only supported type of section objects. They are positioned at the origin of the local space. Their normal in local space points down the negative z -axis, like the camera.

mi::base::Interface_declare\< ..., neuraylib::IScene_element \>Mixin class template for deriving new interface declarations. Common base interface for all scene elements.Common base interface for all scene elements. mi::base::Interface_declare\< ..., neuraylib::IAttribute_set \>Mixin class template for deriving new interface declarations. The attribute set comprises all attributes attached to a database element.The attribute set comprises all attributes attached to a database element. mi::base::Interface_declare\< ... \>Mixin class template for deriving new interface declarations. The basic extensible interface.The basic extensible interface.

Public Member Functions

virtual Color_struct get_cap_color() const =0
Retrieves this plane's capping color. More...
virtual bool  get_clip_light() const =0
Indicates whether the section plane also affects lights (or only geometry). More...
virtual void set_cap_color( const Color_struct&) =0
Sets an individual section capping color for this plane. More...
virtual void set_clip_light( bool flag) =0
Specifies whether the section plane also affects lights (or only geometry).

Member Functions

virtual Color_struct mi::​neuraylib::​ISection_object::get_cap_color() const [pure virtual]

Retrieves this plane's capping color. The result will be an invalid color (components < 0) if this plane has no dedicated capping color.

See also:

set_cap_color

virtual bool mi::​neuraylib::​ISection_object::get_clip_light() const [pure virtual]

Indicates whether the section plane also affects lights (or only geometry). When the parameter is set to true, also the geometry behind the section plane occludes incoming light. The default is false.

virtual void mi::​neuraylib::​ISection_object::set_cap_color( const Color_struct&) [pure virtual]

Sets an individual section capping color for this plane. If this color is set to a valid value (all components >= 0), and if section caps are enabled, objects cut by this plane will be capped with the provided color. If no color is set, or the provided color is invalid, the default capping color is used.

Note that this color does not determine whether clipped objects are capped at all. This is determined by a global control.

virtual void mi::​neuraylib::​ISection_object::set_clip_light( bool flag) [pure virtual]

Specifies whether the section plane also affects lights (or only geometry).