Draws a sphere with a colored checkerboard. More...

#include <OGF/scene_graph_gfx/symbols/checker_sphere.h>

Inheritance diagram for OGF::CheckerSphere:

Public Member Functions
	CheckerSphere ()
	CheckerSphere constructor.

	~CheckerSphere () override
	CheckerShpere destructor.

void	set_nb_segments (index_t value)
	Sets the number of segments. More...

index_t	get_checker_size () const

void	set_checker_size (index_t value)

RenderingContext *	get_rendering_context () const
	Gets the rendering context. More...

void	set_rendering_context (RenderingContext *value)
	Sets the rendering context. More...

bool	get_wireframe () const
	Tests whether wireframe mode is active. More...

void	set_wireframe (bool value)
	Sets wireframe mode. More...

const Color &	get_mesh_color () const
	Gets the mesh color. More...

void	set_mesh_color (const Color &value)
	Sets the mesh color. More...

const Color &	get_color1 () const
	Gets one of the colors used to draw the checkerboard. More...

void	set_color1 (const Color &value)
	Sets one of the colors used to draw the checkerboard. More...

const Color &	get_color2 () const
	Gets the other color used to draw the checkerboard. More...

void	set_color2 (const Color &value)
	Sets the other color used to draw the checkerboard. More...

bool	get_lighting () const
	Tests whether lighting is used. More...

void	set_lighting (bool value)
	Sets whether lighting is used. 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__: index_t get_nb_segments() const { return nb_segments_

	__pad1__: void draw(RenderingContext* rendering_context = nullptr)

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

Draws a sphere with a colored checkerboard.

Definition at line 60 of file checker_sphere.h.

Member Function Documentation

◆ get_checker_size()

index_t OGF::CheckerSphere::get_checker_size ( ) const

inline

Gets the checker size.

Returns: the size of a square of the checkerboard, in number of segments.

Definition at line 97 of file checker_sphere.h.

◆ get_color1()

const Color& OGF::CheckerSphere::get_color1 ( ) const

inline

Gets one of the colors used to draw the checkerboard.

Returns: the color

Definition at line 166 of file checker_sphere.h.

◆ get_color2()

const Color& OGF::CheckerSphere::get_color2 ( ) const

inline

Gets the other color used to draw the checkerboard.

Returns: the color

Definition at line 182 of file checker_sphere.h.

◆ get_lighting()

bool OGF::CheckerSphere::get_lighting ( ) const

inline

Tests whether lighting is used.

Return values

true	if lighting is on
false	otherwise

Definition at line 199 of file checker_sphere.h.

◆ get_mesh_color()

const Color& OGF::CheckerSphere::get_mesh_color ( ) const

inline

Gets the mesh color.

Returns: the color used to draw the mes

Definition at line 150 of file checker_sphere.h.

◆ get_rendering_context()

RenderingContext* OGF::CheckerSphere::get_rendering_context ( ) const

inline

Gets the rendering context.

Returns: a pointer to the RenderingContext \TODO we probably do not need this function anymore

Definition at line 115 of file checker_sphere.h.

◆ get_wireframe()

bool OGF::CheckerSphere::get_wireframe ( ) const

inline

Tests whether wireframe mode is active.

Return values

true	if wireframe mode is active
false	otherwise

Definition at line 133 of file checker_sphere.h.

◆ set_checker_size()

void OGF::CheckerSphere::set_checker_size ( index_t value )

inline

Sets the checker size.

Parameters

[in] value the size of a square of the checkerboard, in number of segments.

Definition at line 106 of file checker_sphere.h.

◆ set_color1()

void OGF::CheckerSphere::set_color1 ( const Color & value )

inline

Sets one of the colors used to draw the checkerboard.

Parameters

[in] value the color

Definition at line 174 of file checker_sphere.h.

◆ set_color2()

void OGF::CheckerSphere::set_color2 ( const Color & value )

inline

Sets the other color used to draw the checkerboard.

Parameters

[in] value the color

Definition at line 190 of file checker_sphere.h.

◆ set_lighting()

void OGF::CheckerSphere::set_lighting ( bool value )

inline

Sets whether lighting is used.

Parameters

[in] value true if lighting should be used, false otherwise

Definition at line 208 of file checker_sphere.h.

◆ set_mesh_color()

void OGF::CheckerSphere::set_mesh_color ( const Color & value )

inline

Sets the mesh color.

Parameters

[in] value the color used to draw the mes

Definition at line 158 of file checker_sphere.h.

◆ set_nb_segments()

void OGF::CheckerSphere::set_nb_segments ( index_t value )

inline

Sets the number of segments.

Parameters

[in] value the number of segments used to discretize the sphere

Definition at line 88 of file checker_sphere.h.

◆ set_rendering_context()

void OGF::CheckerSphere::set_rendering_context ( RenderingContext * value )

inline

Sets the rendering context.

Parameters

[in] value a pointer to the RenderingContext \TODO we probably do not need this function anymore

Definition at line 124 of file checker_sphere.h.

◆ set_wireframe()

void OGF::CheckerSphere::set_wireframe ( bool value )

inline

Sets wireframe mode.

Parameters

[in] value true if wireframe mode should be used, false if filled polygons should be used

Definition at line 142 of file checker_sphere.h.

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

OGF/scene_graph_gfx/symbols/checker_sphere.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_checker_size()

◆ get_color1()

◆ get_color2()

◆ get_lighting()

◆ get_mesh_color()

◆ get_rendering_context()

◆ get_wireframe()

◆ set_checker_size()

◆ set_color1()

◆ set_color2()

◆ set_lighting()

◆ set_mesh_color()

◆ set_nb_segments()

◆ set_rendering_context()

◆ set_wireframe()