cgv
Loading...
Searching...
No Matches
cgv::base::object_constructor Struct Referenceabstract

abstract base class of helpers to perform delayed registration and creation of objects in case that the registration is currently disabled More...

#include <register.h>

Inheritance diagram for cgv::base::object_constructor:
cgv::base::base cgv::data::ref_counted cgv::reflect::self_reflection_tag cgv::base::object_constructor_impl< T > cgv::base::object_constructor_impl_1< T, CA > cgv::base::object_constructor_impl_2< T, CA1, CA2 >

Public Member Functions

std::string get_type_name () const
 return the type name of the object constructor class
 
virtual std::string get_constructed_type_name () const =0
 return the type name of the to be constructed object
 
virtual base_ptr construct_object () const =0
 creation function
 
- Public Member Functions inherited from cgv::base::base
virtual std::string get_default_options () const
 overload to provide default options for registration
 
std::string get_name_or_type_name () const
 determine name of instance by checking cgv::base::named interface and in failure fallback to get_type_name()
 
virtual void on_register ()
 overload to handle register events that is sent after the instance has been registered
 
virtual void unregister ()
 overload to handle unregistration of instances
 
virtual bool on_exit_request ()
 overload to handle the appication exit request, return true if exiting is allowed and false otherwise
 
virtual void stream_stats (std::ostream &)
 overload to show the content of this object
 
virtual data::ref_ptr< named, trueget_named ()
 perform downcast to named
 
virtual data::ref_ptr< node, trueget_node ()
 perform downcast to node
 
virtual data::ref_ptr< group, trueget_group ()
 perform downcast to group
 
virtual data::ref_ptr< const named, trueget_named_const () const
 perform downcast to const named
 
virtual data::ref_ptr< const node, trueget_node_const () const
 perform downcast to const node
 
virtual data::ref_ptr< const group, trueget_group_const () const
 perform downcast to const group
 
template<class T >
data::ref_ptr< T, truecast ()
 cast to arbitrary class, but use the casts to named, node and group from the interface
 
template<class T >
data::ref_ptr< const T, truecast_const ()
 const cast to arbitrary class, but use the casts to named, node and group from the interface
 
template<class T >
Tget_interface ()
 use dynamic type cast to check for the given interface
 
template<class T >
const Tget_const_interface () const
 use dynamic type cast to check for the given interface
 
virtual void update ()
 this virtual update allows for example to ask a view to update the viewed value. The default implementation is empty.
 
virtual voidget_user_data () const
 this virtual method allows to pass application specific data for internal purposes
 
virtual bool self_reflect (cgv::reflect::reflection_handler &)
 used for simple self reflection
 
virtual std::string get_property_declarations ()
 return a semicolon separated list of property declarations
 
virtual bool set_void (const std::string &property, const std::string &value_type, const void *value_ptr)
 abstract interface for the setter of a dynamic property.
 
virtual void on_set (void *member_ptr)
 this callback is called when the set_void method has changed a member and can be overloaded in derived class
 
virtual bool get_void (const std::string &property, const std::string &value_type, void *value_ptr)
 abstract interface for the getter of a dynamic property.
 
virtual bool call_void (const std::string &method, const std::vector< std::string > &param_value_types, const std::vector< const void * > &param_value_ptrs, const std::string &result_type="", void *result_value_ptr=0)
 abstract interface to call an action
 
void set (const std::string &property, const char *value)
 specialization of set method to support const char* as strings
 
template<typename T >
void set (const std::string &property, const T &value)
 set a property of the element to the given value and perform standard conversions if necessary.
 
template<typename T >
T get (const std::string &property)
 query a property of the element and perform standard conversions if necessary.
 
void multi_set (const std::string &property_assignments, bool report_error=true)
 set several properties
 
bool is_property (const std::string &property_name, std::string *type_name=0)
 check if the given name specifies a property.
 
voidfind_member_ptr (const std::string &property_name, std::string *type_name=0)
 find a member pointer by name.
 
- Public Member Functions inherited from cgv::data::ref_counted
int get_ref_count () const
 read access to current count
 

Additional Inherited Members

- Protected Member Functions inherited from cgv::base::base
virtual ~base ()
 make destructor virtual and not accessible from outside
 
- Protected Member Functions inherited from cgv::data::ref_counted
 ref_counted ()
 constructor initializes the count to 0
 
void set_ref_count (int c) const
 write access is also const to allow ref counted pointers to const instances
 
- Static Protected Member Functions inherited from cgv::base::base
template<class T >
static data::ref_ptr< T, truecast_dynamic (base *b)
 use dynamic cast for upcast to given class
 

Detailed Description

abstract base class of helpers to perform delayed registration and creation of objects in case that the registration is currently disabled

Definition at line 97 of file register.h.

Member Function Documentation

◆ construct_object()

virtual base_ptr cgv::base::object_constructor::construct_object ( ) const
pure virtual

◆ get_constructed_type_name()

virtual std::string cgv::base::object_constructor::get_constructed_type_name ( ) const
pure virtual

◆ get_type_name()

std::string cgv::base::object_constructor::get_type_name ( ) const
inlinevirtual

return the type name of the object constructor class

Reimplemented from cgv::base::base.

Reimplemented in cgv::base::object_constructor_impl< T >, cgv::base::object_constructor_impl_1< T, CA >, and cgv::base::object_constructor_impl_2< T, CA1, CA2 >.

Definition at line 101 of file register.h.

References cgv::type::info::type_name< T >::get_name().


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