iMSTK: imstk::GeometryMap Class Reference

Base class for any geometric map. More...

Inheritance diagram for imstk::GeometryMap:

[legend]

Collaboration diagram for imstk::GeometryMap:

Public Member Functions
virtual const std::string	getTypeName () const =0
	Returns the string class name. More...

virtual void	compute ()=0
	Compute the map, usually called once on startup.


void	setParentGeometry (std::shared_ptr< Geometry > parent)
	Get/Set parent geometry.

std::shared_ptr< Geometry >	getParentGeometry () const


void	setChildGeometry (std::shared_ptr< Geometry > child)
	Get/Set child geometry.

std::shared_ptr< Geometry >	getChildGeometry () const

Public Member Functions inherited from imstk::GeometryAlgorithm
std::shared_ptr< Geometry >	getInput (size_t port=0) const
	Returns input geometry given port, returns nullptr if doesn't exist.

std::shared_ptr< Geometry >	getOutput (size_t port=0) const
	Returns output geometry given port, returns nullptr if doesn't exist.

void	setInput (std::shared_ptr< Geometry > inputGeometry, size_t port=0)
	Set the input at the port.

void	update ()
	Do the actual algorithm.

Additional Inherited Members
Protected Types inherited from imstk::GeometryAlgorithm
using	GeometryCheck = std::function< bool(Geometry *)>

using	TypeCheckContainer = std::unordered_map< size_t, GeometryCheck >

Protected Member Functions inherited from imstk::GeometryAlgorithm
void	setOutput (std::shared_ptr< Geometry > inputGeometry, const size_t port=0)
	Set the output at the port.

template<typename T >
void	setRequiredInputType (const size_t port)
	Declares the type for the port with the given number, also defines that the give port is required for the filter to run correctly.

template<typename T >
void	setOptionalInputType (const size_t port)
	Declares the type for the port with the given number, the data for this port is optional and may be omitted.

virtual void	requestUpdate ()=0
	Users can implement this for the logic to be run.

virtual bool	areInputsValid ()
	Check inputs are correct. More...

void	setNumInputPorts (const size_t numPorts)
	Get/Set the amount of input ports.

	imstkGetMacro (NumInputPorts, size_t)

void	setNumOutputPorts (const size_t numPorts)
	Get/Set the amount of output ports.

	imstkGetMacro (NumOutputPorts, size_t)

Protected Attributes inherited from imstk::GeometryAlgorithm
TypeCheckContainer	m_requiredTypeChecks

TypeCheckContainer	m_optionalTypeChecks

Detailed Description

Base class for any geometric map.

Definition at line 20 of file imstkGeometryMap.h.

virtual const std::string imstk::GeometryMap::getTypeName ( ) const

pure virtual

Returns the string class name.

Required for using IMSTK_TYPE_MACRO

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