Controls a 3d transform by different means. More...

#include <OGF/scene_graph_gfx/transforms/transform3d.h>

Inheritance diagram for OGF::Transform3d:

Public Member Functions
	Transform3d ()
	Transform3d constructor.

	~Transform3d () override
	Transform3d destructor.

void	set_look_at (const vec3 &value)
	Sets the origin.

const vec3 &	get_u () const
	Gets the u vector.

void	set_u (const vec3 &value)
	Sets the u vector.

const vec3 &	get_v () const
	Gets the v vector.

void	set_v (const vec3 &value)
	Sets the v vector.

const vec3 &	get_w () const
	Gets the w vector.

void	set_w (const vec3 &value)
	Sets the w vector.

double	get_delta_location () const
	Gets the increment for position changes.

void	set_delta_location (double value)
	Sets the increment for position changes.

double	get_delta_angle () const
	Gets the increment for angle changes.

void	set_delta_angle (double value)
	Sets the increment for angle changes.

double	get_zoom () const
	Gets the zooming factor.

void	set_zoom (double value)
	Sets the zooming factor.

double	get_delta_zoom () const
	Gets the increment for zooming.

void	set_delta_zoom (double value)
	Sets the increment for zooming.

const mat4 &	get_matrix () const
	Gets the current transform.

void	set_matrix (const mat4 &value)
	Sets the current transform.

const mat4 &	get_rotation_matrix () const
	Gets the rotational part of the current transform.

void	set_rotation_matrix (const mat4 &value)
	Sets the rotational part of the current transform.

const vec3 &	get_default_look_at () const
	Gets the default origin.

void	set_default_look_at (const vec3 &value)
	Sets the default origin.

const vec3 &	get_default_u () const
	Gets the default u vector.

void	set_default_u (const vec3 &value)
	Sets the default u vector.

const vec3 &	get_default_v () const
	Gets the default v vector.

void	set_default_v (const vec3 &value)
	Sets the default v vector.

const vec3 &	get_default_w () const
	Gets the default w vector.

void	set_default_w (const vec3 &value)
	Sets the default w vector.

double	get_default_zoom () const
	Gets the default zoom factor.

void	set_default_zoom (double value)
	Sets the default zoom factor.

void	move_left (double value=1.0)
	translates to the left, along the u vector.

void	move_right (double value=1.0)
	translates to the right, along the u vector.

void	move_up (double value=1.0)
	translates to the up, along the v vector.

void	move_down (double value=1.0)
	translates to the bottom, along the v vector.

void	move_forward (double value=1.0)
	translates to the front, along the w vector.

void	move_backward (double value=1.0)
	translates to the back, along the w vector.

void	turn_left (double value=1.0)
	Turn to the left.

void	turn_right (double value=1.0)
	Turn to the right.

void	tilt_up (double value=1.0)
	Tilt towards the up.

void	tilt_down (double value=1.0)
	Tilt towards the bottom.

void	tilt_left (double value=1.0)
	Tilt towards the left.

void	tilt_right (double value=1.0)
	Tilt towards the right.

void	translate (const vec3 &value)
	Applies a translation.

void	rotate (const mat4 &value)
	Applies a rotation.

void	zoom_in (double value=1.0)
	Zooms in.

void	zoom_out (double value=1.0)
	Zooms out.

void	zoom_mult (double value=1.0)
	Applies a scaling to the current zoom.

void	rotation_changed (const mat4 &value)
	A signal that is triggered each time the rotational component of the transform changes.

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

	~Object () override
	Object destructor.

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

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

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

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

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

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.

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

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

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

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

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.

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

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

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

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

void	get_element (index_t item, index_t component, Any &value) const
	Gets an element by item and component.

void	set_element (index_t item, index_t component, const Any &value)
	Sets an element by item and component.

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

virtual index_t	get_dimension () const
	Gets the number of elements per item.

bool	get_signals_enabled () const
	Tests wheter signals are enabled.

void	set_signals_enabled (bool value)
	Enables or disables signals.

bool	get_slots_enabled () const
	Tests wheter slots are enabled.

void	set_slots_enabled (bool value)
	Enables or disables slots.

MetaClass *	get_meta_class () const
	Gets the meta class.

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

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

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

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

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

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.

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

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

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

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

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

void	unref () const
	Decrements the reference count.

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

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

Public Attributes
	: const vec3& get_look_at() const { return look_at_

	: void reset()

gom_signals	: void value_changed(const mat4& value)

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

	: bool equals(const Object* other) const

Protected Member Functions
void	update_matrix (bool send_signal=true)
	Updates the matrix representation of the transform.

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.

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

virtual	~Counted ()
	Destroys a reference counted object.

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.

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

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

Detailed Description

Controls a 3d transform by different means.

Definition at line 58 of file transform3d.h.

Member Function Documentation

◆ get_default_look_at()

const vec3 & OGF::Transform3d::get_default_look_at ( ) const

inline

Gets the default origin.

Returns: the default origin

See also: reset()

Definition at line 265 of file transform3d.h.

◆ get_default_u()

const vec3 & OGF::Transform3d::get_default_u ( ) const

inline

Gets the default u vector.

Returns: the default u vector.

See also: reset()

Definition at line 283 of file transform3d.h.

◆ get_default_v()

const vec3 & OGF::Transform3d::get_default_v ( ) const

inline

Gets the default v vector.

Returns: the default v vector.

See also: reset()

Definition at line 301 of file transform3d.h.

◆ get_default_w()

const vec3 & OGF::Transform3d::get_default_w ( ) const

inline

Gets the default w vector.

Returns: the default w vector.

See also: reset()

Definition at line 319 of file transform3d.h.

◆ get_default_zoom()

double OGF::Transform3d::get_default_zoom ( ) const

inline

Gets the default zoom factor.

Returns: the default zoom factor

See also: reset()

Definition at line 337 of file transform3d.h.

◆ get_delta_angle()

double OGF::Transform3d::get_delta_angle ( ) const

inline

Gets the increment for angle changes.

Returns: the increment for angle changes

See also: turn_left(), turn_right(), tilt_left(), tilt_right(), tilt_up(), tilt_down()

Definition at line 175 of file transform3d.h.

◆ get_delta_location()

double OGF::Transform3d::get_delta_location ( ) const

inline

Gets the increment for position changes.

Returns: the increment for position changes

See also: move_up(), move_down(), move_right(), move_left(), move_forward(), move_backward()

Definition at line 153 of file transform3d.h.

◆ get_delta_zoom()

double OGF::Transform3d::get_delta_zoom ( ) const

inline

Gets the increment for zooming.

Returns: the increment for zooming

See also: zoom_in(), zoom_out()

Definition at line 212 of file transform3d.h.

◆ get_matrix()

const mat4 & OGF::Transform3d::get_matrix ( ) const

inline

Gets the current transform.

Returns: the current transform, as a 4x4 homogeneous- coordinates matrix

Definition at line 230 of file transform3d.h.

◆ get_rotation_matrix()

const mat4 & OGF::Transform3d::get_rotation_matrix ( ) const

Gets the rotational part of the current transform.

Returns: the rotational part of the current transform, as a 4x4 homogeneous-coordinates matrix (with zero translation)

◆ get_u()

const vec3 & OGF::Transform3d::get_u ( ) const

inline

Gets the u vector.

The u vector points to the right.

Returns: the u vector

Definition at line 94 of file transform3d.h.

◆ get_v()

const vec3 & OGF::Transform3d::get_v ( ) const

inline

Gets the v vector.

The v vector points to the top.

Returns: the v vector

Definition at line 113 of file transform3d.h.

◆ get_w()

const vec3 & OGF::Transform3d::get_w ( ) const

inline

Gets the w vector.

The w vector points to the front.

Returns: the w vector

Definition at line 132 of file transform3d.h.

◆ get_zoom()

double OGF::Transform3d::get_zoom ( ) const

inline

Gets the zooming factor.

Returns: the zooming factor

Definition at line 194 of file transform3d.h.

◆ move_backward()

void OGF::Transform3d::move_backward ( double value = 1.0 )

translates to the back, along the w vector.

Parameters

[in] value the length of the displacement, that will be multiplied by delta_location before being applied.

◆ move_down()

void OGF::Transform3d::move_down ( double value = 1.0 )

translates to the bottom, along the v vector.

Parameters

[in] value the length of the displacement, that will be multiplied by delta_location before being applied.

◆ move_forward()

void OGF::Transform3d::move_forward ( double value = 1.0 )

translates to the front, along the w vector.

Parameters

[in] value the length of the displacement, that will be multiplied by delta_location before being applied.

◆ move_left()

void OGF::Transform3d::move_left ( double value = 1.0 )

translates to the left, along the u vector.

Parameters

[in] value the length of the displacement, that will be multiplied by delta_location before being applied.

◆ move_right()

void OGF::Transform3d::move_right ( double value = 1.0 )

translates to the right, along the u vector.

Parameters

[in] value the length of the displacement, that will be multiplied by delta_location before being applied.

◆ move_up()

void OGF::Transform3d::move_up ( double value = 1.0 )

translates to the up, along the v vector.

Parameters

[in] value the length of the displacement, that will be multiplied by delta_location before being applied.

◆ rotate()

void OGF::Transform3d::rotate ( const mat4 & value )

Applies a rotation.

Parameters

[in] value the rotational part of the transform is composed with the specified rotation

◆ rotation_changed()

void OGF::Transform3d::rotation_changed ( const mat4 & value )

A signal that is triggered each time the rotational component of the transform changes.

Parameters

[in] value the rotation, as a 4x4 homogeneous- coordinates matrix, with zero translation.

◆ set_default_look_at()

void OGF::Transform3d::set_default_look_at ( const vec3 & value )

inline

Sets the default origin.

Parameters

[in] value the default origin

See also: reset()

Definition at line 274 of file transform3d.h.

◆ set_default_u()

void OGF::Transform3d::set_default_u ( const vec3 & value )

inline

Sets the default u vector.

Parameters

[in] value the default u vector

See also: reset()

Definition at line 292 of file transform3d.h.

◆ set_default_v()

void OGF::Transform3d::set_default_v ( const vec3 & value )

inline

Sets the default v vector.

Parameters

[in] value the default v vector

See also: reset()

Definition at line 310 of file transform3d.h.

◆ set_default_w()

void OGF::Transform3d::set_default_w ( const vec3 & value )

inline

Sets the default w vector.

Parameters

[in] value the default w vector

See also: reset()

Definition at line 328 of file transform3d.h.

◆ set_default_zoom()

void OGF::Transform3d::set_default_zoom ( double value )

inline

Sets the default zoom factor.

Parameters

[in] value the default zoom factor

See also: reset()

Definition at line 346 of file transform3d.h.

◆ set_delta_angle()

void OGF::Transform3d::set_delta_angle ( double value )

inline

Sets the increment for angle changes.

Parameters

[in] value the increment for angle changes

See also: turn_left(), turn_right(), tilt_left(), tilt_right(), tilt_up(), tilt_down()

Definition at line 186 of file transform3d.h.

◆ set_delta_location()

void OGF::Transform3d::set_delta_location ( double value )

inline

Sets the increment for position changes.

Parameters

[in] value the increment for position changes

See also: move_up(), move_down(), move_right(), move_left(), move_forward(), move_backward()

Definition at line 164 of file transform3d.h.

◆ set_delta_zoom()

void OGF::Transform3d::set_delta_zoom ( double value )

inline

Sets the increment for zooming.

Parameters

[in] value the increment for zooming

See also: zoom_in(), zoom_out()

Definition at line 221 of file transform3d.h.

◆ set_look_at()

void OGF::Transform3d::set_look_at ( const vec3 & value )

inline

Sets the origin.

Parameters

[in] value the origin

Definition at line 84 of file transform3d.h.

◆ set_matrix()

void OGF::Transform3d::set_matrix ( const mat4 & value )

inline

Sets the current transform.

Parameters

[in] value the transform, as a 4x4 homogeneous- coordinates matrix \TODO compute u,v,w,lookat from matrix.

Definition at line 240 of file transform3d.h.

◆ set_rotation_matrix()

void OGF::Transform3d::set_rotation_matrix ( const mat4 & value )

Sets the rotational part of the current transform.

Parameters

[in] value the rotational part to be set in the current transform, as a 4x4 homogeneous-coordinates matrix (with zero translation)

◆ set_u()

void OGF::Transform3d::set_u ( const vec3 & value )

inline

Sets the u vector.

The u vector points to the right.

Parameters

[in] value the u vector

Definition at line 103 of file transform3d.h.

◆ set_v()

void OGF::Transform3d::set_v ( const vec3 & value )

inline

Sets the v vector.

The v vector points to the top.

Parameters

[in] value the v vector

Definition at line 122 of file transform3d.h.

◆ set_w()

void OGF::Transform3d::set_w ( const vec3 & value )

inline

Sets the w vector.

The w vector points to the front.

Parameters

[in] value the w vector

Definition at line 141 of file transform3d.h.

◆ set_zoom()

void OGF::Transform3d::set_zoom ( double value )

inline

Sets the zooming factor.

Parameters

[in] value the zooming factor

Definition at line 202 of file transform3d.h.

◆ tilt_down()

void OGF::Transform3d::tilt_down ( double value = 1.0 )

Tilt towards the bottom.

Like pushing the stick in a plane.

Parameters

[in] value the rotation angle, multiplied by delta_angle before being applied \TODO not implemented yet!

◆ tilt_left()

void OGF::Transform3d::tilt_left ( double value = 1.0 )

Tilt towards the left.

Parameters

[in] value the rotation angle, multiplied by delta_angle before being applied \TODO not implemented yet!

◆ tilt_right()

void OGF::Transform3d::tilt_right ( double value = 1.0 )

Tilt towards the right.

Parameters

[in] value the rotation angle, multiplied by delta_angle before being applied \TODO not implemented yet!

◆ tilt_up()

void OGF::Transform3d::tilt_up ( double value = 1.0 )

Tilt towards the up.

Like pulling the stick in a plane.

Parameters

[in] value the rotation angle, multiplied by delta_angle before being applied \TODO not implemented yet!

◆ translate()

void OGF::Transform3d::translate ( const vec3 & value )

Applies a translation.

This function is used to implement panning in Graphite's 3D view.

Parameters

[in] value the translation vector, only its X and Y components are used. They are multiplied by the zooming factor before beeing added to look_at.

◆ turn_left()

void OGF::Transform3d::turn_left ( double value = 1.0 )

Turn to the left.

Parameters

[in] value the rotation angle, multiplied by delta_angle before being applied \TODO not implemented yet!

◆ turn_right()

void OGF::Transform3d::turn_right ( double value = 1.0 )

Turn to the right.

Parameters

[in] value the rotation angle, multiplied by delta_angle before being applied \TODO not implemented yet!

◆ update_matrix()

void OGF::Transform3d::update_matrix ( bool send_signal = true )

protected

Updates the matrix representation of the transform.

Parameters

[in] send_signal if true, value_changed() and rotation_changed() are triggered.

◆ zoom_in()

void OGF::Transform3d::zoom_in ( double value = 1.0 )

Zooms in.

Parameters

[in] value number of times zooming factor is multiplied by delta_zoom.

◆ zoom_mult()

void OGF::Transform3d::zoom_mult ( double value = 1.0 )

Applies a scaling to the current zoom.

Parameters

[in] value scaling applied to the current zooming factor.

◆ zoom_out()

void OGF::Transform3d::zoom_out ( double value = 1.0 )

Zooms out.

Parameters

[in] value number of times zooming factor is divided by delta_zoom.

Member Data Documentation

◆ pad0

OGF::Transform3d::__pad0__

Definition at line 68 of file transform3d.h.

◆ pad1

OGF::Transform3d::__pad1__

Definition at line 346 of file transform3d.h.

◆ pad2

gom_signals OGF::Transform3d::__pad2__

Definition at line 487 of file transform3d.h.

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

OGF/scene_graph_gfx/transforms/transform3d.h

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_default_look_at()

◆ get_default_u()

◆ get_default_v()

◆ get_default_w()

◆ get_default_zoom()

◆ get_delta_angle()

◆ get_delta_location()

◆ get_delta_zoom()

◆ get_matrix()

◆ get_rotation_matrix()

◆ get_u()

◆ get_v()

◆ get_w()

◆ get_zoom()

◆ move_backward()

◆ move_down()

◆ move_forward()

◆ move_left()

◆ move_right()

◆ move_up()

◆ rotate()

◆ rotation_changed()

◆ set_default_look_at()

◆ set_default_u()

◆ set_default_v()

◆ set_default_w()

◆ set_default_zoom()

◆ set_delta_angle()

◆ set_delta_location()

◆ set_delta_zoom()

◆ set_look_at()

◆ set_matrix()

◆ set_rotation_matrix()

◆ set_u()

◆ set_v()

◆ set_w()

◆ set_zoom()

◆ tilt_down()

◆ tilt_left()

◆ tilt_right()

◆ tilt_up()

◆ translate()

◆ turn_left()

◆ turn_right()

◆ update_matrix()

◆ zoom_in()

◆ zoom_mult()

◆ zoom_out()

Member Data Documentation

◆ __pad0__

◆ __pad1__

◆ __pad2__

◆ pad0

◆ pad1

◆ pad2