#include <VisualGrid.h>

Inheritance diagram for sofa::component::visual::VisualGrid:

Public Attributes
Data< std::string >	d_plane
	Plane of the grid. More...

Data< float >	d_size
	Size of the squared grid. More...

Data< int >	d_nbSubdiv
	Number of subdivisions. More...

Data< sofa::type::RGBAColor >	d_color
	Color of the lines in the grid. default=(0.34,0.34,0.34,1.0) More...

Data< float >	d_thickness
	Thickness of the lines in the grid. More...

core::objectmodel::lifecycle::RemovedData	d_draw {this, "v23.06", "23.12", "draw", "Use the 'enable' data field instead of 'draw'"}

Public Attributes inherited from sofa::core::visual::VisualModel
Data< bool >	d_enable
	Display the object or not. More...

Public Attributes inherited from sofa::core::objectmodel::BaseObject
Data< bool >	f_listening
	if true, handle the events, otherwise ignore the events More...

Public Attributes inherited from sofa::core::objectmodel::Base
std::vector< lifecycle::DeprecatedData * >	m_oldAttributes

Data< int >	d_messageLogCount

Data< std::string >	name
	Name of the object. More...

Data< bool >	f_printLog
	if true, emits extra messages at runtime. More...

Data< sofa::core::objectmodel::TagSet >	f_tags
	list of the subsets the object belongs to More...

Data< sofa::type::BoundingBox >	f_bbox
	this object bounding box More...

Data< sofa::core::objectmodel::ComponentState >	d_componentState
	The state of the component among (Dirty, Valid, Undefined, Loading, Invalid). More...

std::string	m_definitionSourceFileName {""}

int	m_definitionSourceFilePos {-1}

std::string	m_instanciationSourceFileName {""}

int	m_instanciationSourceFilePos {-1}

Protected Attributes
PLANE	internalPlane
	Pre-computed points used to draw the grid. More...

sofa::type::vector< Vec3 >	m_drawnPoints

Protected Attributes inherited from sofa::core::objectmodel::BaseObject
SingleLink< BaseObject, BaseContext, BaseLink::FLAG_DOUBLELINK >	l_context

LinkSlaves	l_slaves

SingleLink< BaseObject, BaseObject, BaseLink::FLAG_DOUBLELINK >	l_master

Protected Attributes inherited from sofa::core::objectmodel::Base
std::map< std::string, sofa::core::DataTrackerCallback >	m_internalEngine

VecData	m_vecData
	List of fields (Data instances) More...

MapData	m_aliasData
	name -> Data multi-map (includes names and aliases) More...

VecLink	m_vecLink
	List of links. More...

MapLink	m_aliasLink
	name -> Link multi-map (includes names and aliases) More...

Public Member Functions
	SOFA_CLASS (VisualGrid, VisualModel)

	SOFA_ATTRIBUTE_REPLACED__TYPEMEMBER (Vector3, sofa::type::Vec3)

	VisualGrid ()

	~VisualGrid () override=default

void	init () override
	Initialization method called at graph creation and modification, during top-down traversal. More...

void	reinit () override
	Update method called when variables used in precomputation are modified. More...

void	doDrawVisual (const core::visual::VisualParams *) override

void	doUpdateVisual (const core::visual::VisualParams *) override

void	updateGrid ()

void	buildGrid ()

Public Member Functions inherited from sofa::core::visual::VisualModel
	SOFA_ABSTRACT_CLASS (VisualModel, objectmodel::BaseObject)

virtual void	drawVisual (const VisualParams *) final
	Display the VisualModel object. More...

void	initVisual (const VisualParams *)
	Initialize the textures, or other graphical resources. More...

virtual void	initVisual () final

void	updateVisual (const VisualParams *)
	used to update the model if necessary. More...

virtual void	updateVisual () final

virtual void	clearVisual ()
	clear some graphical resources (generally called before the deleteVisitor). More...

virtual void	fwdDraw (VisualParams *)
	Called before objects in the current branch are displayed. More...

virtual void	bwdDraw (VisualParams *)
	Called after objects in the current branch are displayed. More...

virtual void	drawTransparent (const VisualParams *)
	Display transparent surfaces. More...

virtual void	drawShadow (const VisualParams *vparams)
	Display shadow-casting surfaces. More...

virtual void	parallelUpdateVisual ()
	used to update the model if necessary. More...

virtual bool	addBBox (SReal , SReal )
	used to add the bounding-box of this visual model to the given bounding box in order to compute the scene bounding box or cull hidden objects. More...

virtual void	applyTranslation (const SReal, const SReal, const SReal)

virtual void	applyRotation (const SReal, const SReal, const SReal)

virtual void	applyRotation (const type::Quat< SReal >)

virtual void	applyScale (const SReal, const SReal, const SReal)

virtual void	exportOBJ (std::string, std::ostream , std::ostream , sofa::Index &, sofa::Index &, sofa::Index &, int &)
	Append this mesh to an OBJ format stream. More...

bool	insertInNode (objectmodel::BaseNode *node) override

bool	removeInNode (objectmodel::BaseNode *node) override

Public Member Functions inherited from sofa::core::objectmodel::BaseObject
	SOFA_CLASS (BaseObject, Base)

virtual void	draw (const core::visual::VisualParams *)
	Render internal data of this object, for debugging purposes. More...

virtual void	computeBBox (const core::ExecParams *, bool=false)

void	setSrc (const std::string &v, std::vector< std::string > *attributeList=nullptr)
	Sets a source Object and parses it to collect dependent Data. More...

void	setSrc (const std::string &v, const BaseObject loader, std::vector< std::string > attributeList=nullptr)

Base *	findLinkDestClass (const BaseClass destType, const std::string &path, const BaseLink link) override

virtual std::string	getPathName () const override
	Return the full path name of this object. More...

SReal	getTime () const
	Current time. More...

const BaseContext *	getContext () const

BaseContext *	getContext ()

const BaseObject *	getMaster () const

BaseObject *	getMaster ()

const VecSlaves &	getSlaves () const

BaseObject *	getSlave (const std::string &name) const

virtual void	addSlave (BaseObject::SPtr s)

virtual void	removeSlave (BaseObject::SPtr s)

virtual void	handleEvent (Event *)
	Handle an event. More...

virtual void	handleTopologyChange ()

virtual void	handleTopologyChange (core::topology::Topology *t)

void	parse (BaseObjectDescription *arg) override
	Parse the given description to assign values to this object's fields and potentially other parameters. More...

virtual void	bwdInit ()
	Initialization method called at graph creation and modification, during bottom-up traversal. More...

void	updateInternal ()
	Update method called when variables (used to compute other internal variables) are modified. More...

virtual void	storeResetState ()
	Save the initial state for later uses in reset() More...

virtual void	reset ()
	Reset to initial state. More...

virtual void	cleanup ()

Public Member Functions inherited from sofa::core::objectmodel::Base
virtual const BaseClass *	getClass () const

void	addDeprecatedAttribute (lifecycle::DeprecatedData *attribute)

void	addUpdateCallback (const std::string &name, std::initializer_list< BaseData * > inputs, std::function< sofa::core::objectmodel::ComponentState(const DataTracker &)> function, std::initializer_list< BaseData * > outputs)

void	addOutputsToCallback (const std::string &name, std::initializer_list< BaseData * > outputs)

const std::string &	getName () const
	Accessor to the object name. More...

void	setName (const std::string &n)
	Set the name of this object. More...

void	setName (const std::string &n, int counter)
	Set the name of this object, adding an integer counter. More...

std::string	getTypeName () const
	Get the type name of this object (i.e. class and template types) More...

virtual std::string	getClassName () const
	Get the class name of this object. More...

virtual std::string	getTemplateName () const final
	Get the template type names (if any) used to instantiate this object. More...

std::string	getNameSpaceName () const
	Get the template type names (if any) used to instantiate this object. More...

void	setDefinitionSourceFileName (const std::string &sourceFileName)
	Set the source filename (where the component is implemented) More...

const std::string &	getDefinitionSourceFileName () const
	Get the source filename (where the component is implemented) More...

void	setDefinitionSourceFilePos (const int)
	Set the source location (where the component is implemented) More...

int	getDefinitionSourceFilePos () const
	Get the source location (where the component is implemented) More...

void	setInstanciationSourceFileName (const std::string &sourceFileName)

const std::string &	getInstanciationSourceFileName () const

void	setInstanciationSourceFilePos (const int)

int	getInstanciationSourceFilePos () const

void	addMessage (const sofa::helper::logging::Message &m) const

size_t	countLoggedMessages (sofa::helper::logging::Message::TypeSet t=sofa::helper::logging::Message::AnyTypes) const

const std::deque< sofa::helper::logging::Message > &	getLoggedMessages () const

const std::string	getLoggedMessagesAsString (sofa::helper::logging::Message::TypeSet t=sofa::helper::logging::Message::AnyTypes) const

void	clearLoggedMessages () const

bool	notMuted () const

const sofa::core::objectmodel::TagSet &	getTags () const
	Represents the subsets the object belongs to. More...

bool	hasTag (Tag t) const
	Return true if the object belong to the given subset. More...

void	addTag (Tag t)
	Add a subset qualification to the object. More...

void	removeTag (Tag t)
	Remove a subset qualification to the object. More...

ComponentState	getComponentState () const

bool	isComponentStateValid () const

virtual bool	parseField (const std::string &attribute, const std::string &value)
	Assign one field value (Data or Link) More...

virtual bool	hasField (const std::string &attribute) const
	Check if a given Data field or Link exists. More...

void	parseFields (const std::list< std::string > &str)
	Assign the field values stored in the given list of name + value pairs of strings. More...

virtual void	parseFields (const std::map< std::string, std::string * > &str)
	Assign the field values stored in the given map of name -> value pairs. More...

void	writeDatas (std::map< std::string, std::string * > &str)
	Write the current field values to the given map of name -> value pairs. More...

void	writeDatas (std::ostream &out, const std::string &separator=" ")

BaseData *	findData (const std::string &name) const

std::vector< BaseData * >	findGlobalField (const std::string &name) const
	Find data fields given a name: several can be found as we look into the alias map. More...

BaseLink *	findLink (const std::string &name) const

std::vector< BaseLink * >	findLinks (const std::string &name) const
	Find link fields given a name: several can be found as we look into the alias map. More...

virtual void	updateLinks (bool logErrors=true)
	Update pointers in case the pointed-to objects have appeared. More...

template<class T >
BaseData::BaseInitData	initData (::sofa::core::objectmodel::Data< T > field, const char name, const char *help, ::sofa::core::objectmodel::BaseData::DataFlags dataflags)
	Helper method used to initialize a data field containing a value of type T. More...

template<class T >
BaseData::BaseInitData	initData (Data< T > field, const char name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
	Helper method used to initialize a data field containing a value of type T. More...

template<class T >
Data< T >::InitData	initData (Data< T > field, const T &value, const char name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
	Helper method used to initialize a data field containing a value of type T. More...

void	addData (BaseData *f, const std::string &name)

void	addData (BaseData *f)

void	removeData (BaseData *f)
	Remove a data field. More...

void	addAlias (BaseData field, const char alias)
	Add an alias to a Data. More...

void	addLink (BaseLink *l)
	Add a link. More...

void	addAlias (BaseLink link, const char alias)
	Add an alias to a Link. More...

const VecData &	getDataFields () const
	Accessor to the vector containing all the fields of this object. More...

const MapData &	getDataAliases () const
	Accessor to the map containing all the aliases of this object. More...

const VecLink &	getLinks () const
	Accessor to the vector containing all the fields of this object. More...

const MapLink &	getLinkAliases () const
	Accessor to the map containing all the aliases of this object. More...

virtual bool	findDataLinkDest (BaseData &ptr, const std::string &path, const BaseLink link)

template<class T >
bool	findLinkDest (T &ptr, const std::string &path, const BaseLink link)

Additional Inherited Members
Static Public Member Functions inherited from sofa::core::objectmodel::BaseObject
template<class T >
static bool	canCreate (T , BaseContext , BaseObjectDescription *)
	Pre-construction check method called by ObjectFactory. More...

template<class T >
static T::SPtr	create (T , BaseContext context, BaseObjectDescription *arg)
	Construction method called by ObjectFactory. More...

Static Public Member Functions inherited from sofa::core::objectmodel::Base
static const BaseClass *	GetClass ()

template<class T >
static std::string	shortName (const T ptr=nullptr, BaseObjectDescription =nullptr)

Protected Member Functions inherited from sofa::core::visual::VisualModel
	VisualModel ()

	~VisualModel () override

Protected Member Functions inherited from sofa::core::objectmodel::BaseObject
	BaseObject ()

	~BaseObject () override

virtual void	doUpdateInternal ()
	Implementation of the internal update. More...

void	changeContextLink (BaseContext before, BaseContext &after)

void	changeSlavesLink (BaseObject::SPtr ptr, std::size_t, bool add)
	This method insures that slaves objects have master and context links set correctly. More...

void	trackInternalData (const BaseData &data)
	Method called to add the Data to the DataTracker (listing the Data to track) More...

void	cleanTracker ()

bool	hasDataChanged (const BaseData &data)
	Method called to know if a tracked Data has changed. More...

Protected Member Functions inherited from sofa::core::objectmodel::Base
	Base ()

virtual	~Base ()

void	initData0 (BaseData field, BaseData::BaseInitData &res, const char name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
	Helper method used by initData() More...

void	initData0 (BaseData field, BaseData::BaseInitData &res, const char name, const char *help, BaseData::DataFlags dataFlags)
	Helper method used by initData() More...

template<class T >
void	initData0 (Data< T > field, typename Data< T >::InitData &res, const T &value, const char name, const char *help, bool isDisplayed=true, bool isReadOnly=false)
	Helper method used by initData() More...

Attribute details

◆ d_color

Data<sofa::type::RGBAColor> sofa::component::visual::VisualGrid::d_color

Color of the lines in the grid. default=(0.34,0.34,0.34,1.0)

◆ d_draw

core::objectmodel::lifecycle::RemovedData sofa::component::visual::VisualGrid::d_draw {this, "v23.06", "23.12", "draw", "Use the 'enable' data field instead of 'draw'"}

◆ d_nbSubdiv

Data<int> sofa::component::visual::VisualGrid::d_nbSubdiv

Number of subdivisions.

◆ d_plane

Data<std::string> sofa::component::visual::VisualGrid::d_plane

Plane of the grid.

◆ d_size

Data<float> sofa::component::visual::VisualGrid::d_size

Size of the squared grid.

◆ d_thickness

Data<float> sofa::component::visual::VisualGrid::d_thickness

Thickness of the lines in the grid.

◆ internalPlane

PLANE sofa::component::visual::VisualGrid::internalPlane

protected

Pre-computed points used to draw the grid.

◆ m_drawnPoints

sofa::type::vector<Vec3> sofa::component::visual::VisualGrid::m_drawnPoints

protected

Constructor details

◆ VisualGrid()

sofa::component::visual::VisualGrid::VisualGrid ( )

◆ ~VisualGrid()

sofa::component::visual::VisualGrid::~VisualGrid ( )

overridedefault

Function details

◆ buildGrid()

void sofa::component::visual::VisualGrid::buildGrid ( )

◆ doDrawVisual()

void sofa::component::visual::VisualGrid::doDrawVisual ( const core::visual::VisualParams * vparams )

overridevirtual

Reimplemented from sofa::core::visual::VisualModel.

◆ doUpdateVisual()

void sofa::component::visual::VisualGrid::doUpdateVisual ( const core::visual::VisualParams * )

overridevirtual

Reimplemented from sofa::core::visual::VisualModel.

◆ init()

void sofa::component::visual::VisualGrid::init ( void )

overridevirtual

Initialization method called at graph creation and modification, during top-down traversal.

Reimplemented from sofa::core::objectmodel::BaseObject.

◆ reinit()

void sofa::component::visual::VisualGrid::reinit ( )

overridevirtual

Update method called when variables used in precomputation are modified.

Reimplemented from sofa::core::objectmodel::BaseObject.

◆ SOFA_ATTRIBUTE_REPLACED__TYPEMEMBER()

sofa::component::visual::VisualGrid::SOFA_ATTRIBUTE_REPLACED__TYPEMEMBER	(	Vector3	,
		sofa::type::Vec3
	)

◆ SOFA_CLASS()

sofa::component::visual::VisualGrid::SOFA_CLASS	(	VisualGrid	,
		VisualModel
	)

◆ updateGrid()

void sofa::component::visual::VisualGrid::updateGrid ( )

Enum details

◆ PLANE

enum sofa::component::visual::VisualGrid::PLANE

Enumerator
PLANE_X
PLANE_Y
PLANE_Z

Public Attributes

Protected Attributes

Public Member Functions

Additional Inherited Members

Attribute details

◆ d_color

◆ d_draw

◆ d_nbSubdiv

◆ d_plane

◆ d_size

◆ d_thickness

◆ internalPlane

◆ m_drawnPoints

Constructor details

◆ VisualGrid()

◆ ~VisualGrid()

Function details

◆ buildGrid()

◆ doDrawVisual()

◆ doUpdateVisual()

◆ init()

◆ reinit()

◆ SOFA_ATTRIBUTE_REPLACED__TYPEMEMBER()

◆ SOFA_CLASS()

◆ updateGrid()

Enum details

◆ PLANE