Application attributes and methods related with camera management. More...

#include <OGF/skin_imgui/types/camera.h>

Inheritance diagram for OGF::Camera:

Public Member Functions
	Camera (Application *app)
	Camera constructor. More...

	~Camera () override
	Camera destructor.

bool	get_auto_focus () const
	Tests whether autofocus is active. More...

void	set_draw_selected_only (bool value)
	Sets whether only the selected object should be drawn. More...

bool	get_draw_selected_only () const
	Tests whether only the selected object should be drawn. More...

void	set_bkg_color_1 (const Color &value)
	Sets the primary background color. More...

const Color &	get_bkg_color_1 () const
	Gets the background color. More...

void	set_bkg_color_2 (const Color &value)
	Sets the secondary background color. More...

const Color &	get_bkg_color_2 () const
	Gets the secondary background color. More...

void	set_effect (const FullScreenEffectName &effect)
	Sets the full screen effect. More...

const FullScreenEffectName &	get_effect () const
	Gets the full screen effect. More...

FullScreenEffect *	get_effect_object () const
	Gets the full screen effect object. More...

void	set_clipping (ClippingConfig value)
	Sets the current clipping configuration. More...

ClippingConfig	get_clipping () const
	Gets the current clipping configuration. More...

mat4	get_lighting_matrix () const
	Gets the lighting matrix. More...

void	set_lighting_matrix (const mat4 &value)
	Sets the lighting matrix. More...

Public Member Functions inherited from OGF::Object
	Object (bool transient=false)
	Object constructor. More...

virtual	~Object ()
	Object destructor.

virtual MetaClass *	meta_class () const
	Gets the meta class. More...

virtual void	set_meta_class (MetaClass *mclass)
	Sets the meta class. More...

unsigned int	id () const
	Gets the identifier of this object. More...

std::string	string_id () const
	Gets the unique string identifier. More...

bool	has_method (const std::string &method_name) const
	Tests whether a method is defined. More...

virtual bool	invoke_method (const std::string &method_name, const ArgList &args, Any &ret_val)
	Invokes a method by method name and argument list, and gets the return value. More...

bool	invoke_method (const std::string &method_name, const ArgList &args)
	Invokes a method by method name and argument list. More...

bool	invoke_method (const std::string &method_name)
	Invokes a method by method name. More...

bool	has_property (const std::string &prop_name) const
	Tests whether a property is defined. More...

virtual bool	get_property (const std::string &prop_name, std::string &prop_value) const
	Gets a property. More...

virtual Connection *	connect_signal_to_slot (const std::string &signal_name, Object *to, const std::string &slot_name)
	Connects a signal with a slot of another object. More...

virtual void	add_connection (Connection *connection)
	Adds a connection to this object. More...

virtual void	remove_connection (Connection *connection)
	Removes a connection to this object. More...

virtual void	get_element (index_t i, Any &value) const
	Gets an element by index. More...

virtual void	set_element (index_t i, const Any &value)
	Sets an element by index. More...

virtual void	search (const std::string &needle, const std::string &path="")
	Displays the names of all objects that contain a substring. More...

bool	get_signals_enabled () const
	Tests wheter signals are enabled. More...

void	set_signals_enabled (bool value)
	Enables or disables signals. More...

bool	get_slots_enabled () const
	Tests wheter slots are enabled. More...

void	set_slots_enabled (bool value)
	Enables or disables slots. More...

MetaClass *	get_meta_class () const
	Gets the meta class. More...

std::string	get_string_id () const
	Gets the unique string identifier. More...

virtual std::string	get_doc () const
	Gets the documentation. More...

virtual Sign	compare (const Object *other) const
	Compares this object with another one. More...

virtual bool	is_a (const MetaType *type) const
	Tests whether this object inherits a given type. More...

void	disconnect ()
	Removes all connections from signals of this objects. More...

void	enable_signals ()
	Enables signals.

void	disable_signals ()
	Disables signals.

void	enable_slots ()
	Enables slots.

void	disable_slots ()
	Disables slots.

void	set_properties (const ArgList &args)
	Sets several properties in a single call. More...

virtual bool	set_property (const std::string &name, const std::string &value)
	Sets an individual property. More...

void	help () const
	Displays some help about this object. More...

virtual bool	set_property (const std::string &name, const Any &value)
	Sets an individual property. More...

virtual bool	get_property (const std::string &prop_name, Any &prop_value) const
	Gets a property. More...

Public Member Functions inherited from GEO::Counted
void	ref () const
	Increments the reference count. More...

void	unref () const
	Decrements the reference count. More...

bool	is_shared () const
	Check if the object is shared. More...

int	nb_refs () const
	Gets the number of references that point to this object. More...

Public Attributes
	__pad0__: void set_auto_focus(bool value)

	__pad1__: SceneGraphShaderManager* scene_graph_shader_manager() const

Public Attributes inherited from OGF::Object
	__pad0__: virtual index_t get_nb_elements() const

	__pad1__: bool equals(const Object* other) const

Additional Inherited Members
Static Public Member Functions inherited from OGF::Object
static Object *	id_to_object (unsigned int id)
	Gets an object from a unique object id. More...

Static Public Member Functions inherited from GEO::Counted
static void	ref (const Counted *counted)
	Increments the reference count. More...

static void	unref (const Counted *counted)
	Decrements the reference count. More...

Protected Member Functions inherited from OGF::Object
virtual bool	emit_signal (const std::string &signal_name, const ArgList &args, bool called_from_slot=false)
	Emits a signal and calls the slots it is connected to. More...

Protected Member Functions inherited from GEO::Counted
	Counted ()
	Creates a reference counted object. More...

virtual	~Counted ()
	Destroys a reference counted object. More...

Detailed Description

Application attributes and methods related with camera management.

Camera does not store any information by itself. It only routes attributes and slots to other GOM objects (SceneGraphShaderManager and RenderArea). Gathering them in a single place makes it simpler to generate the GUI.

Definition at line 72 of file camera.h.

Constructor & Destructor Documentation

◆ Camera()

OGF::Camera::Camera ( Application * app )

Camera constructor.

Parameters

[in] app a pointer to the Application

Member Function Documentation

◆ get_auto_focus()

bool OGF::Camera::get_auto_focus ( ) const

Tests whether autofocus is active.

In autofocus mode, the focus matrix adapts the camera to display the current object.

Return values

true	if autofocus is active
false	otherwise

◆ get_bkg_color_1()

const Color& OGF::Camera::get_bkg_color_1 ( ) const

Gets the background color.

Returns: the background color

◆ get_bkg_color_2()

const Color& OGF::Camera::get_bkg_color_2 ( ) const

Gets the secondary background color.

If different from the (primary) background color, then a color-ramp between both is generated.

◆ get_clipping()

ClippingConfig OGF::Camera::get_clipping ( ) const

Gets the current clipping configuration.

Returns

a ';'-separated string with the following fields:

active (one of "true","false")
axis (one of "x","y","z","d")
volume-mode (one of "std.","cell","strad.","slice")
shift (an integer in [-250, 250])
rotation (the 16 coefficients of a rotation matrix)
invert (one of "true", "false")

◆ get_draw_selected_only()

bool OGF::Camera::get_draw_selected_only ( ) const

Tests whether only the selected object should be drawn.

Return values

true	if only the selected object is drawn
false	if the whole scene graph is drawn

◆ get_effect()

const FullScreenEffectName& OGF::Camera::get_effect ( ) const

Gets the full screen effect.

Returns: the user effect name.

◆ get_effect_object()

FullScreenEffect* OGF::Camera::get_effect_object ( ) const

Gets the full screen effect object.

Returns: a pointer to the FullScreenEffect.

◆ get_lighting_matrix()

mat4 OGF::Camera::get_lighting_matrix ( ) const

Gets the lighting matrix.

Returns: the lighting matrix.

◆ set_bkg_color_1()

void OGF::Camera::set_bkg_color_1 ( const Color & value )

Sets the primary background color.

Parameters

[in] value the background color

◆ set_bkg_color_2()

void OGF::Camera::set_bkg_color_2 ( const Color & value )

Sets the secondary background color.

If different from the (primary) background color, then a color-ramp between both is generated.

Parameters

[in] value the secondary background color

◆ set_clipping()

void OGF::Camera::set_clipping ( ClippingConfig value )

Sets the current clipping configuration.

Parameters

[in]

value

a ';'-separated string with the following fields:

active (one of "true","false")
axis (one of "x","y","z","d")
volume-mode (one of "std.","cell","strad.","slice")
shift (an integer in [-250, 250])
rotation (the 16 coefficients of a rotation matrix)
invert (one of "true", "false")

◆ set_draw_selected_only()

void OGF::Camera::set_draw_selected_only ( bool value )

Sets whether only the selected object should be drawn.

Parameters

[in] value true if only the selected object is drawn, false if the whole scene graph is drawn

◆ set_effect()

void OGF::Camera::set_effect ( const FullScreenEffectName & effect )

Sets the full screen effect.

Parameters

[in] effect the user effect name.

◆ set_lighting_matrix()

void OGF::Camera::set_lighting_matrix ( const mat4 & value )

Sets the lighting matrix.

Parameters

[in] value the new lighting matrix.

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

OGF/skin_imgui/types/camera.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Camera()

Member Function Documentation

◆ get_auto_focus()

◆ get_bkg_color_1()

◆ get_bkg_color_2()

◆ get_clipping()

◆ get_draw_selected_only()

◆ get_effect()

◆ get_effect_object()

◆ get_lighting_matrix()

◆ set_bkg_color_1()

◆ set_bkg_color_2()

◆ set_clipping()

◆ set_draw_selected_only()

◆ set_effect()

◆ set_lighting_matrix()