Converts a 2D picking in a rendering window into a ray picking event. More...

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

Inheritance diagram for OGF::RayPicker:

Public Member Functions
	RayPicker ()
	RayPicker constructor.

	~RayPicker () override
	RayPicker destructor.

void	drag (RenderingContext *rendering_context, const vec2 &point_ndc, int button)
	Callback called when the mouse is dragged with a button pressed.

void	release (RenderingContext *rendering_context, const vec2 &point_ndc, int button)
	Callback called when a mouse button is released.

void	ray_drag (RenderingContext *rendering_context, const RayPick &value)
	The signal triggered when the mouse is dragged.

void	ray_release (RenderingContext *rendering_context, const RayPick &value)
	The signal triggered when a mouse button is released.

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
	: void grab( RenderingContext* rendering_context

const vec2 &	point_ndc

const vec2 int	button

gom_signals	: void ray_grab( RenderingContext* rendering_context

gom_signals const RayPick &	value

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

	: bool equals(const Object* other) const

Protected Member Functions
RayPick	point_to_ray_pick (RenderingContext *context, const vec2 &p_ndc, int button)
	Converts a mouse pointer location into a RayPick event.

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

Converts a 2D picking in a rendering window into a ray picking event.

For now, just copies the 2D NDC coordinates of the event into the target RayPick. It can be used as a placeholder for more elaborate picking mechanisms.

See also: RayPick

Definition at line 126 of file ray_picker.h.

Member Function Documentation

◆ drag()

void OGF::RayPicker::drag	(	RenderingContext *	rendering_context,
		const vec2 &	point_ndc,
		int	button
	)

Callback called when the mouse is dragged with a button pressed.

Parameters

[in]	rendering_context	a pointer to the RenderingContext
[in]	point_ndc	the point under the mouse pointer, in normalized device coordinates (x and y both in [-1.0, 1.0])
[in]	button	the button that is pressed

◆ point_to_ray_pick()

RayPick OGF::RayPicker::point_to_ray_pick	(	RenderingContext *	context,
		const vec2 &	p_ndc,
		int	button
	)

protected

Converts a mouse pointer location into a RayPick event.

For now, just copies p_ndc and button in the RayPick event. This can be a placeholder for more sophisticated picking mechanisms (e.g., with a stylus that has an orientation sensor).

Parameters

[in]	context	a pointer to the RenderingContext
[in]	p_ndc	the point under the mouse pointer, in normalized device coordinates (X and Y both in [-1.0, 1.0])
[in]	button	the button that was pressed/dragged or released

Returns: the RayPick event

◆ ray_drag()

void OGF::RayPicker::ray_drag	(	RenderingContext *	rendering_context,
		const RayPick &	value
	)

The signal triggered when the mouse is dragged.

Parameters

[in]	rendering_context	a pointer to the RenderingContext
[in]	value	the RayPick event generated from the mouse pointer location

◆ ray_release()

void OGF::RayPicker::ray_release	(	RenderingContext *	rendering_context,
		const RayPick &	value
	)

The signal triggered when a mouse button is released.

Parameters

[in]	rendering_context	a pointer to the RenderingContext
[in]	value	the RayPick event generated from the mouse pointer location

◆ release()

void OGF::RayPicker::release	(	RenderingContext *	rendering_context,
		const vec2 &	point_ndc,
		int	button
	)

Callback called when a mouse button is released.

Parameters

[in]	rendering_context	a pointer to the RenderingContext
[in]	point_ndc	the point under the mouse pointer, in normalized device coordinates (x and y both in [-1.0, 1.0])
[in]	button	the button that is released

Member Data Documentation

◆ pad0

OGF::RayPicker::__pad0__

Definition at line 136 of file ray_picker.h.

◆ pad1

gom_signals OGF::RayPicker::__pad1__

Definition at line 177 of file ray_picker.h.

◆ button

const vec2 int OGF::RayPicker::button

Definition at line 149 of file ray_picker.h.

◆ point_ndc

const vec2& OGF::RayPicker::point_ndc

Definition at line 149 of file ray_picker.h.

◆ value

gom_signals const RayPick& OGF::RayPicker::value

Definition at line 185 of file ray_picker.h.

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

OGF/scene_graph_gfx/transforms/ray_picker.h

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ drag()

◆ point_to_ray_pick()

◆ ray_drag()

◆ ray_release()

◆ release()

Member Data Documentation

◆ __pad0__

◆ __pad1__

◆ button

◆ point_ndc

◆ value

◆ pad0

◆ pad1