A scriptable Vector objects. More...

#include <OGF/scene_graph/NL/vector.h>

Inheritance diagram for OGF::NL::Vector:

Public Member Functions
	Vector (index_t size=0, index_t dimension=1, MetaType *element_meta_type=nullptr)
	Vector constructor.

	Vector (Grob grob, AttributeStore attribute_store)
	Vector constructor.

	Vector (Grob grob, void data, index_t size, index_t dimension, MetaType *element_meta_type, bool read_only)
	Vector constructor.

	~Vector () override
	Vector destructor.

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

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

Memory::pointer	data () const
	Gets the data pointer.

double *	data_double () const
	Gets the data pointer as doubles.

index_t *	data_index_t () const
	Gets the data pointer as index_t.

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

index_t	get_size () const
	Gets the size.

MetaType *	get_element_meta_type () const
	Gets the MetaType of the elements.

bool	get_read_only () const
	Tests whether this Vector is read-only.

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.

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.

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 Member Functions inherited from GEO::AttributeStoreObserver
	AttributeStoreObserver ()
	Creates a new uninitialied AttributeStore.

void	notify (Memory::pointer base_addr, index_t size, index_t dim)
	Callback function, called by the AttributeStore whenever it is modified.

index_t	size () const
	Gets the size.

index_t	dimension () const
	Gets the dimension.

index_t	nb_elements () const
	Gets the total number of elements.

void	register_me (AttributeStore *store)
	Registers this observer to an AttributeStore.

void	unregister_me (AttributeStore *store)
	Unregisters this observer from an AttributeStore.

void	disconnect ()
	Disconnects this AttributeStoreObserver from its AttributeStore.

Public Attributes
	: index_t get_nb_elements() const override { return nb_elements()

	: virtual void resize( index_t new_size

index_t	new_dim =1

index_t MetaType *	element_meta_type

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

	: bool equals(const Object* other) const

Protected Member Functions
bool	check_index (index_t i) const
	Tests whether index i is valid.

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.

Protected Attributes inherited from GEO::AttributeStoreObserver
Memory::pointer	base_addr_

index_t	size_

index_t	dimension_

bool	disconnected_

Detailed Description

A scriptable Vector objects.

Definition at line 53 of file vector.h.

Constructor & Destructor Documentation

◆ Vector() [1/3]

OGF::NL::Vector::Vector	(	index_t	size = `0`,
		index_t	dimension = `1`,
		MetaType *	element_meta_type = `nullptr`
	)

Vector constructor.

Parameters

[in]	size	number of items
[in]	dimension	number of elements per item
[in]	element_meta_type	type of the elements. If nullptr defaults to double

◆ Vector() [2/3]

OGF::NL::Vector::Vector	(	Grob *	grob,
		AttributeStore *	attribute_store
	)

Vector constructor.

Constructs a view on a Grob attribute.

Parameters

[in]	grob	a pointer to a Grob.
[in]	attribute_store	a pointer to an AttributeStore of the Grob.

◆ Vector() [3/3]

OGF::NL::Vector::Vector	(	Grob *	grob,
		void *	data,
		index_t	size,
		index_t	dimension,
		MetaType *	element_meta_type,
		bool	read_only
	)

Vector constructor.

Parameters

[in]	grob	a pointer to a Grob or nil
[in]	data	data pointer
[in]	size	number of items
[in]	dimension	number of elements per item
[in]	element_meta_type	type of the elements.
[in]	read_only	indicates whether the vector can be modified

Member Function Documentation

◆ check_index()

bool OGF::NL::Vector::check_index ( index_t i ) const

protected

Tests whether index i is valid.

If index is invalid, displays an error message.

Return values

true	if index i is in 0 .. get_size()-1
false	otherwise.

◆ data()

Memory::pointer OGF::NL::Vector::data ( ) const

inline

Gets the data pointer.

Returns: a pointer to the first element. All elements are stored contiguously.

Definition at line 117 of file vector.h.

◆ data_double()

double * OGF::NL::Vector::data_double ( ) const

Gets the data pointer as doubles.

Returns: a pointer to the first element. All elements are stored contiguously. If data type is not double, returns nullptr.

◆ data_index_t()

index_t * OGF::NL::Vector::data_index_t ( ) const

Gets the data pointer as index_t.

Returns: a pointer to the first element. All elements are stored contiguously. If data type is not index_t, returns nullptr.

◆ get_dimension()

index_t OGF::NL::Vector::get_dimension ( ) const

inlineoverridevirtual

Gets the number of elements per item.

Part of the array interface, used by operator[] in scripting language.

Reimplemented from OGF::Object.

Definition at line 147 of file vector.h.

◆ get_element()

void OGF::NL::Vector::get_element	(	index_t	i,
		Any &	value
	)		const

overridevirtual

Gets an element by linear index.

Parameters

[in]	i	element index, in 0..nb_elements()-1
[out]	value	the value of the element, stored in an Any.

Reimplemented from OGF::Object.

◆ get_element_meta_type()

MetaType * OGF::NL::Vector::get_element_meta_type ( ) const

inline

Gets the MetaType of the elements.

Returns: a pointer to the MetaType of the elements.

Definition at line 163 of file vector.h.

◆ get_read_only()

bool OGF::NL::Vector::get_read_only ( ) const

inline

Tests whether this Vector is read-only.

Return values

true	if this Vector is read-only.
false	if this Vector is read-write.

Definition at line 172 of file vector.h.

◆ get_size()

index_t OGF::NL::Vector::get_size ( ) const

inline

Gets the size.

Returns: the number of items.

Definition at line 155 of file vector.h.

◆ set_element()

void OGF::NL::Vector::set_element	(	index_t	i,
		const Any &	value
	)

overridevirtual

Sets an element by linear index.

Parameters

[in]	i	element index, in 0..nb_elements()-1
[in]	value	the value of the element, stored in an Any.

Reimplemented from OGF::Object.

Member Data Documentation

◆ pad0

OGF::NL::Vector::__pad0__

Definition at line 133 of file vector.h.

◆ pad1

OGF::NL::Vector::__pad1__

Definition at line 172 of file vector.h.

◆ element_meta_type

index_t MetaType* OGF::NL::Vector::element_meta_type

Initial value:

=nullptr

)

Definition at line 188 of file vector.h.

◆ new_dim

index_t OGF::NL::Vector::new_dim =1

Definition at line 187 of file vector.h.

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

OGF/scene_graph/NL/vector.h

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Vector() [1/3]

◆ Vector() [2/3]

◆ Vector() [3/3]

Member Function Documentation

◆ check_index()

◆ data()

◆ data_double()

◆ data_index_t()

◆ get_dimension()

◆ get_element()

◆ get_element_meta_type()

◆ get_read_only()

◆ get_size()

◆ set_element()

Member Data Documentation

◆ __pad0__

◆ __pad1__

◆ element_meta_type

◆ new_dim

◆ pad0

◆ pad1