GOM wrapper around AmbientOcclusionImpl. More...

#include <OGF/scene_graph_gfx/full_screen_effects/ambient_occlusion.h>

Inheritance diagram for OGF::AmbientOcclusion:

Public Member Functions
	AmbientOcclusion (SceneGraph *scene_graph)
	AmbientOcclusion constructor.

FullScreenEffectImpl *	implementation () override
	Gets the implementation.

void	set_lightness (index_t value)
	Sets the lightness.

index_t	get_contrast () const
	Gets the contrast.

void	set_contrast (index_t value)
	Sets the contrast.

index_t	get_blur_width () const
	Gets the size of the blurring kernel.

void	set_blur_width (index_t value)
	Sets the size of the blurring kernel.

index_t	get_nb_directions () const
	Gets the number of directions.

void	set_nb_directions (index_t value)
	Sets the number of directions.

double	get_max_radius () const
	Gets the maximum radius around a pixel where ambient occlusion is computed.

void	set_max_radius (double x)
	Sets the maximum radius around a pixel where ambient occlusion is computed.

double	get_step_mul () const
	Gets the multiplicative factor applied to each step when traversing from a pixel.

void	set_step_mul (double x)
	Sets the multiplicative factor applied to each step when traversing from a pixel.

Public Member Functions inherited from OGF::FullScreenEffect
	FullScreenEffect (SceneGraph *scene_graph)
	FullScreenEffect constructor.

virtual void	update ()
	Triggers an update of both the implementation and the 3D view.

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
	: index_t get_lightness() const { return impl_->get_lightness()

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

	: 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.

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.

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.

Detailed Description

GOM wrapper around AmbientOcclusionImpl.

Definition at line 54 of file ambient_occlusion.h.

Constructor & Destructor Documentation

◆ AmbientOcclusion()

OGF::AmbientOcclusion::AmbientOcclusion ( SceneGraph * scene_graph )

AmbientOcclusion constructor.

Parameters

[in] scene_graph a pointer to the SceneGraph.

Member Function Documentation

◆ get_blur_width()

index_t OGF::AmbientOcclusion::get_blur_width ( ) const

inline

Gets the size of the blurring kernel.

Returns: the size of the blurring kernel, in pixels.

Definition at line 103 of file ambient_occlusion.h.

◆ get_contrast()

index_t OGF::AmbientOcclusion::get_contrast ( ) const

inline

Gets the contrast.

Returns: the contrast, as an integer.

A value of 10 (default) corresponds to average contrast.

Definition at line 87 of file ambient_occlusion.h.

◆ get_max_radius()

double OGF::AmbientOcclusion::get_max_radius ( ) const

inline

Gets the maximum radius around a pixel where ambient occlusion is computed.

Returns: the radius, relative to screen size, in 0.0 ... 1.0.

Definition at line 135 of file ambient_occlusion.h.

◆ get_nb_directions()

index_t OGF::AmbientOcclusion::get_nb_directions ( ) const

inline

Gets the number of directions.

These directions are used to compute the visibility integrals (the higher, the better), typical value is 5 to 10.

Returns: x the number of directions.

Definition at line 119 of file ambient_occlusion.h.

◆ get_step_mul()

double OGF::AmbientOcclusion::get_step_mul ( ) const

inline

Gets the multiplicative factor applied to each step when traversing from a pixel.

Returns: the multiplicative step.

Definition at line 151 of file ambient_occlusion.h.

◆ implementation()

FullScreenEffectImpl * OGF::AmbientOcclusion::implementation ( )

overridevirtual

Gets the implementation.

Returns: a pointer to the FullScreenEffectImpl that implements this FullScreenEffect.

Implements OGF::FullScreenEffect.

◆ set_blur_width()

void OGF::AmbientOcclusion::set_blur_width ( index_t value )

inline

Sets the size of the blurring kernel.

Parameters

[in] x the size of the blurring kernel, in pixels.

Definition at line 110 of file ambient_occlusion.h.

◆ set_contrast()

void OGF::AmbientOcclusion::set_contrast ( index_t value )

inline

Sets the contrast.

A value of 10 (default) corresponds to average contrast.

Definition at line 94 of file ambient_occlusion.h.

◆ set_lightness()

void OGF::AmbientOcclusion::set_lightness ( index_t value )

inline

Sets the lightness.

Parameters

[in] x the lightness, as an integer.

A value of 10 (default) corresponds to average lightness.

Definition at line 79 of file ambient_occlusion.h.

◆ set_max_radius()

void OGF::AmbientOcclusion::set_max_radius ( double x )

inline

Sets the maximum radius around a pixel where ambient occlusion is computed.

Parameters

[in] x the radius, relative to screen size, in 0.0 ... 1.0.

Definition at line 142 of file ambient_occlusion.h.

◆ set_nb_directions()

void OGF::AmbientOcclusion::set_nb_directions ( index_t value )

inline

Sets the number of directions.

These directions are used to compute the visibility integrals (the higher, the better), typical value is 5 to 10.

Parameters

[in] x the number of directions.

Definition at line 126 of file ambient_occlusion.h.

◆ set_step_mul()

void OGF::AmbientOcclusion::set_step_mul ( double x )

inline

Sets the multiplicative factor applied to each step when traversing from a pixel.

Parameters

[in] x the multiplicative step.

Definition at line 158 of file ambient_occlusion.h.

Member Data Documentation

◆ pad0

OGF::AmbientOcclusion::__pad0__

Definition at line 65 of file ambient_occlusion.h.

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

OGF/scene_graph_gfx/full_screen_effects/ambient_occlusion.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AmbientOcclusion()

Member Function Documentation

◆ get_blur_width()

◆ get_contrast()

◆ get_max_radius()

◆ get_nb_directions()

◆ get_step_mul()

◆ implementation()

◆ set_blur_width()

◆ set_contrast()

◆ set_lightness()

◆ set_max_radius()

◆ set_nb_directions()

◆ set_step_mul()

Member Data Documentation

◆ __pad0__

◆ pad0