OpenCMISS::Zinc::Sceneviewermodule Class Reference

Module object for creating and managing scene viewers. More...

#include <sceneviewer.hpp>

Public Member Functions
	Sceneviewermodule (cmzn_sceneviewermodule_id in_sceneviewermodule_id)
	Sceneviewermodule (const Sceneviewermodule &sceneviewermodule)
Sceneviewermodule &	operator= (const Sceneviewermodule &sceneviewermodule)
bool	isValid () const
cmzn_sceneviewermodule_id	getId () const
Sceneviewer	createSceneviewer (Sceneviewer::BufferingMode buffering_mode, Sceneviewer::StereoMode stereo_mode)
int	getDefaultBackgroundColourRGB (double *valuesOut3)
int	setDefaultBackgroundColourRGB (const double *valuesIn3)

Protected Attributes
cmzn_sceneviewermodule_id	id

Detailed Description

Module object for creating and managing scene viewers.

Module object for creating and managing scene viewers.

Member Function Documentation

Sceneviewer OpenCMISS::Zinc::Sceneviewermodule::createSceneviewer ( Sceneviewer::BufferingMode  buffering_mode, Sceneviewer::StereoMode  stereo_mode  )

inline

Returns a handle to a scene viewer object. The scene viewer attributes for buffering mode and stereo mode are also set.

Parameters

buffering_mode	The buffering mode in use for the OpenGL context.
stereo_mode	The stereo mode in use for the OpenGL context.

Returns

Handle to new sceneviewer, or NULL/invalid handle on failure.

int OpenCMISS::Zinc::Sceneviewermodule::getDefaultBackgroundColourRGB ( double *  valuesOut3 )

inline

Gets the default background colour for new scene viewers created from this scene viewer module. The component order in the array is [red, green, blue]

Parameters

valuesOut3

The rgb components of the colour with values in [0, 1.0].

Returns

OpenCMISS::Zinc::OK if successful, otherwise OpenCMISS::Zinc::ERROR_ARGUMENT.

cmzn_sceneviewermodule_id OpenCMISS::Zinc::Sceneviewermodule::getId ( ) const

inline

Return the C handle of the Sceneviewermodule object.

Returns

C handle of Sceneviewermodule if this objects is valid, 0 otherwise.

bool OpenCMISS::Zinc::Sceneviewermodule::isValid ( ) const

inline

Check if this is a valid Sceneviewermodule object.

Returns

Status True if object is valid, false otherwise.

int OpenCMISS::Zinc::Sceneviewermodule::setDefaultBackgroundColourRGB ( const double *  valuesIn3 )

inline

Sets the default background colour for new scene viewers created from this scene viewer module. Each component should be in the range [0, 1.0]. The component order is [red, green, blue].

Parameters

valuesIn3

The RGB components of the colour.

Returns

OpenCMISS::Zinc::OK if successful, otherwise OpenCMISS::Zinc::ERROR_ARGUMENT.

---

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

• auto_comments_output/sceneviewer.hpp