A Grob class for luagrob grids. More...

#include <OGF/luagrob/grob/lua_grob.h>

Inheritance diagram for OGF::LuaGrob:

Public Member Functions
	LuaGrob (CompositeGrob *parent)
	LuaGrob constructor.

	~LuaGrob () override
	LuaGrob destructor.

bool	shader_OK () const
	Tests the status of the loaded LUA program.

void	set_autorun (bool x)
	Sets whether the source should be executed automatically when the object is loaded.

void	set_source (const std::string &source)
	Sets the source of the LUA program.

const std::string &	get_source () const
	Gets the source of the LUA program.

void	set_shader_source (const std::string &source)
	Sets the source of the LUA shader program and executes it.

const std::string &	get_shader_source () const
	Gets the source of the LUA shader program.

bool	execute_shader_command (const std::string &value)
	Executes a LUA command in the interpreter used for the shader.

void	execute_shader_program ()
	Executes the loaded LUA shader program.

void	load_program_source (const std::string &value)
	Loads the LUA program from a file.

void	save_program_source (const std::string &value)
	Saves the LUA program to a file.

void	load_shader_source (const std::string &value)
	Loads the LUA shader program from a file.

void	save_shader_source (const std::string &value)
	Saves the LUA shader program to a file.

void	set_box (const Box3d &box)
	Sets the bounding box.

void	clear () override
	Clears this Grob.

Grob *	duplicate (SceneGraph *sg) override
	Duplicates this Grob.

bool	is_serializable () const override
	Tests whether this Grob can be serialized in GeoFile.

bool	serialize_read (InputGraphiteFile &geofile) override
	Reads this Grob from a GeoFile.

bool	serialize_write (OutputGraphiteFile &geofile) override
	Writes this Grob into a stream.

void	update () override

Box3d	bbox () const override
	Gets the bounding box.

Public Member Functions inherited from OGF::Grob
	Grob (CompositeGrob *parent)
	Grob constructor.

	Grob ()
	Grob constructor.

	~Grob () override
	Grob destructor.

const std::string &	name () const
	Gets the name of this Grob.

virtual Box3d	world_bbox () const
	Gets the bounding box in world coordinates.

void	set_shader (const std::string &value)
	Changes the current shader of this Grob.

void	get_shader_and_shader_properties (std::string &classname, ArgList &properties, bool pointers=true)
	Gets the classname of the shader and its properties.

void	set_shader_and_shader_properties (const std::string &classname, const ArgList &properties)
	Sets the shader and its properties.

ArgList &	attributes ()
	Gets the attributes associated with this Grob.

const ArgList &	attributes () const
	Gets the attributes associated with this Grob.

bool	dirty () const
	Gets the dirty flag.

void	up_to_date ()
	Tests whether this object is up to date.

bool	graphics_are_locked () const
	Tests whether this VoxelGrob is locked for graphics display.

void	lock_graphics ()
	Locks graphics for this VoxelGrob.

void	unlock_graphics ()
	Unlocks graphics for this VoxelGrob.

virtual Interpreter *	interpreter ()
	Gets a pointer to the main Interpreter.

virtual void	redraw ()
	Triggers update events and redraws the scene.

SceneGraph *	scene_graph () const
	Gets the SceneGraph.

virtual bool	load (const FileName &value)
	Replaces this Grob with the contents of a file.

virtual bool	save (const NewFileName &value)
	Saves this Grob to a file.

virtual bool	append (const FileName &value)
	Appends the content of the specified file to this Grob.

virtual void	rename (const std::string &value)
	Renames this Grob.

virtual Object *	query_interface (const std::string &name)
	Creates an Interface object connected to this Grob.

index_t	nb_grob_attributes () const
	gets the number of grob attributes

const std::string &	ith_grob_attribute_name (index_t i) const
	gets the name of a grob attribute

std::string	ith_grob_attribute_value (index_t i) const
	gets the value of a grob attribute

void	set_grob_attribute (const std::string &name, const std::string &value)
	sets the value of a grob attribute

void	set_filename (const std::string &value)
	Sets the name of this Grob.

const std::string &	get_filename () const
	Gets the filename of this Grob.

bool	get_visible () const
	Tests whether this Grob is visible.

void	set_visible (bool value)
	Sets the visibility flag of this Grob.

Object *	get_shader () const
	Gets the shader associated with this Grob.

Object *	get_shader_manager () const
	Gets the ShaderManager associated with this Grob.

void	set_obj_to_world_transform (const mat4 &value)
	Sets the object to world transform.

const mat4 &	get_obj_to_world_transform () const
	Gets the object to world transform.

Public Member Functions inherited from OGF::Node
	Node (Node *parent=nullptr)
	Node constructor.

	~Node () override
	Node destructor.

virtual void	add_child (Node *child)
	Adds a child to this Node.

virtual void	remove_child (Node *child)
	Removes a child from this Node. \parma[in] child a pointer to the child to be removed.

Node *	get_parent () const
	Gets the parent.

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.

Static Public Member Functions
static LuaGrob *	find_or_create (SceneGraph *sg, const std::string &name)
	Finds or creates a LuaGrob with the specified name.

static LuaGrob *	find (SceneGraph *sg, const std::string &name)
	Finds a LuaGrob by name.

Static Public Member Functions inherited from OGF::Grob
static Grob *	find (SceneGraph *sg, const std::string &name)
	Finds a Grob by name.

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.

Public Attributes
	: bool get_autorun() const { return autorun_

	: void execute_program()

Public Attributes inherited from OGF::Grob
	: virtual void update()

gom_signals	: virtual void value_changed(Grob* value)

	: const std::string& get_name() const { return name_

Public Attributes inherited from OGF::Node
	: Node* ith_child(index_t i) const { ogf_assert(i < get_nb_children())

return	children_ [i]

	: size_t get_nb_children() const { return children_.size()

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

	: bool equals(const Object* other) const

Additional Inherited Members
Protected Member Functions inherited from OGF::Grob
void	initialize_name (const std::string &name)
	Initializes the name of this Grob.

void	set_shader_manager (Object *s)
	Sets the ShaderManager associated with this Grob.

Protected Member Functions inherited from OGF::Node
void	swap_children (Node n1, Node n2)
	Swaps two children by indices.

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.

Protected Attributes inherited from OGF::Grob
std::string	name_

std::string	filename_

bool	visible_

SceneGraph *	scene_graph_

mat4	obj_to_world_

Object_var	shader_manager_

ArgList	grob_attributes_

bool	dirty_

index_t	nb_graphics_locks_

Detailed Description

A Grob class for luagrob grids.

Definition at line 63 of file lua_grob.h.

Constructor & Destructor Documentation

◆ LuaGrob()

OGF::LuaGrob::LuaGrob ( CompositeGrob * parent )

LuaGrob constructor.

Parameters

[in] parent a pointer to the container (the scenegraph in most cases).

Member Function Documentation

◆ bbox()

Box3d OGF::LuaGrob::bbox ( ) const

overridevirtual

Gets the bounding box.

Returns: the bounding box

Implements OGF::Grob.

◆ clear()

void OGF::LuaGrob::clear ( )

overridevirtual

Clears this Grob.

Reimplemented from OGF::Grob.

◆ duplicate()

Grob * OGF::LuaGrob::duplicate ( SceneGraph * sg )

overridevirtual

Duplicates this Grob.

The newly created Grob has the same name as the current one, with "_copy" appended.

Reimplemented from OGF::Grob.

◆ execute_shader_command()

bool OGF::LuaGrob::execute_shader_command ( const std::string & value )

Executes a LUA command in the interpreter used for the shader.

Parameters

[in] value the command.

◆ find()

static LuaGrob * OGF::LuaGrob::find	(	SceneGraph *	sg,
		const std::string &	name
	)

static

Finds a LuaGrob by name.

Parameters

[in]	sg	a pointer to the SceneGraph
[in]	name	the name

Returns: a pointer to the LuaGrob named as name in the SceneGraph sg if it exists, or nil otherwise.

◆ find_or_create()

static LuaGrob * OGF::LuaGrob::find_or_create	(	SceneGraph *	sg,
		const std::string &	name
	)

static

Finds or creates a LuaGrob with the specified name.

Parameters

[in]	sg	a pointer to the SceneGraph
[in]	name	the name

Returns: a pointer to the LuaGrob named as name in the SceneGraph sg if it exists, or a newly created LuaGrob otherwise.

◆ get_shader_source()

const std::string & OGF::LuaGrob::get_shader_source ( ) const

inline

Gets the source of the LUA shader program.

Returns: the LUA source.

Definition at line 139 of file lua_grob.h.

◆ get_source()

const std::string & OGF::LuaGrob::get_source ( ) const

inline

Gets the source of the LUA program.

Returns: the LUA source.

Definition at line 121 of file lua_grob.h.

◆ is_serializable()

bool OGF::LuaGrob::is_serializable ( ) const

overridevirtual

Tests whether this Grob can be serialized in GeoFile.

Return values

true	if this Grob is serializable
false	otherwise

See also: serialize_read(), serialize_write()

Reimplemented from OGF::Grob.

◆ load_program_source()

void OGF::LuaGrob::load_program_source ( const std::string & value )

Loads the LUA program from a file.

Parameters

[in] value the filename.

◆ load_shader_source()

void OGF::LuaGrob::load_shader_source ( const std::string & value )

Loads the LUA shader program from a file.

Parameters

[in] value the filename.

◆ save_program_source()

void OGF::LuaGrob::save_program_source ( const std::string & value )

Saves the LUA program to a file.

Parameters

[in] value the filename.

◆ save_shader_source()

void OGF::LuaGrob::save_shader_source ( const std::string & value )

Saves the LUA shader program to a file.

Parameters

[in] value the filename.

◆ serialize_read()

bool OGF::LuaGrob::serialize_read ( InputGraphiteFile & geofile )

overridevirtual

Reads this Grob from a GeoFile.

Parameters

[in,out] geofile the input GeoFile

Return values

true	if the Grob could be successfully read
false	otherwise

See also: is_serializable()

Reimplemented from OGF::Grob.

◆ serialize_write()

bool OGF::LuaGrob::serialize_write ( OutputGraphiteFile & geofile )

overridevirtual

Writes this Grob into a stream.

Parameters

[in,out] geofile the output GeoFile The file extension determines the file format used to write the object.

Return values

true	if the Grob could be successfully written
false	otherwise

See also: is_serializable()

Reimplemented from OGF::Grob.

◆ set_autorun()

void OGF::LuaGrob::set_autorun ( bool x )

inline

Sets whether the source should be executed automatically when the object is loaded.

Parameters

[in] x true if the source should be executed automatically, false otherwise.

Definition at line 105 of file lua_grob.h.

◆ set_box()

void OGF::LuaGrob::set_box ( const Box3d & box )

Sets the bounding box.

Parameters

[in] box the new box

◆ set_shader_source()

void OGF::LuaGrob::set_shader_source ( const std::string & source )

inline

Sets the source of the LUA shader program and executes it.

Parameters

[in] source the LUA source.

Definition at line 130 of file lua_grob.h.

◆ set_source()

void OGF::LuaGrob::set_source ( const std::string & source )

inline

Sets the source of the LUA program.

Parameters

[in] source the LUA source.

Definition at line 113 of file lua_grob.h.

◆ shader_OK()

bool OGF::LuaGrob::shader_OK ( ) const

inline

Tests the status of the loaded LUA program.

Return values

true	if program is OK
false	if error occured

Definition at line 82 of file lua_grob.h.

◆ update()

void OGF::LuaGrob::update ( )

override

Member Data Documentation

◆ pad0

OGF::LuaGrob::__pad0__

Definition at line 82 of file lua_grob.h.

◆ pad1

OGF::LuaGrob::__pad1__

Definition at line 139 of file lua_grob.h.

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

OGF/luagrob/grob/lua_grob.h

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LuaGrob()

Member Function Documentation

◆ bbox()

◆ clear()

◆ duplicate()

◆ execute_shader_command()

◆ find()

◆ find_or_create()

◆ get_shader_source()

◆ get_source()

◆ is_serializable()

◆ load_program_source()

◆ load_shader_source()

◆ save_program_source()

◆ save_shader_source()

◆ serialize_read()

◆ serialize_write()

◆ set_autorun()

◆ set_box()

◆ set_shader_source()

◆ set_source()

◆ shader_OK()

◆ update()

Member Data Documentation

◆ __pad0__

◆ __pad1__

◆ pad0

◆ pad1