makVrv::DtPropsInterface Class Reference

The interface for the props widget. More...

Inheritance diagram for makVrv::DtPropsInterface:

List of all members.

Public Types
typedef std::set< DtUniqueID >	UniqueIdSet
Public Member Functions
virtual	~DtPropsInterface ()
	DTOR.
virtual void	addPropType (std::string propType)=0
	Add a prop type to the gui propType must be unique.
virtual void	removePropType (std::string propType)=0
	Remove a prop type from the gui propType must be unique.
virtual void	addProp (const std::string &propName, const std::string &propType, DtUniqueID id)=0
	Add a prop to the gui The pair (propName, propType) must be unique.
virtual void	removeProp (const std::string &propName, const std::string &propType, DtUniqueID id)=0
	Remove a prop from the gui The pair (propName, propType) must be unique.
virtual void	setOpacity (int opacity)=0
	Set the opacity in the gui.
virtual void	setVisibility (int visibility)=0
	Set the visibility in the gui.
virtual void	setPropType (const std::string &propType)=0
	Set the prop type in the gui.
virtual void	setModelDefinition (const std::string &modelDef)=0
	Set the model definition in the gui.
virtual void	setPropSelected (DtUniqueID id, bool selected)=0
	Set a prop item to be selected or unselected.
virtual void	setPropsSelected (const UniqueIdSet &)=0
	Set a group of props selected.
virtual void	setPropsDeselected (const UniqueIdSet &)=0
	Set a group of props deselected.
virtual void	setPosition (double x, double y, double z)=0
	Set the position in the gui.
virtual void	setPositionUnits (const DtUnicode &units)=0
	Set the position units in the gui.
virtual void	setPositionPrecisions (int distDecimals, int altDecimals)=0
	Set the position precision in the gui.
virtual void	setOrientation (const double yaw, const double pitch, const double roll)=0
	Set the orientation in the gui.
virtual void	setOrientationUnits (const DtUnicode &units)=0
	Set the orientation units in the gui.
virtual void	setOrientationPrecision (int decimals)=0
	Set the orientation precision in the gui.
virtual void	setValidSchemas (const std::vector< std::string > &schemaNames)=0
	Set the valid schema types for props.
Public Attributes
boost::signal< void(const UniqueIdSet &)>	signal_selectionChanged
	Emitted when the user has selected a prop tree item.
boost::signal< void()>	signal_removePropsBtnClicked
	Emitted when the user has clicked the remove props button.
boost::signal< void(int)>	signal_opacityChanged
	Emitted when the user has changed the opacity.
boost::signal< void(int)>	signal_visibilityChanged
	Emitted when the user has changed the visibility.
boost::signal< void(const std::string &)>	signal_propTypeChanged
	Emitted when the user has changed the prop type.
boost::signal< void(const std::string &)>	signal_modelDefinitionChanged
	Emitted when the user has changed the Model Definition.
boost::signal< void(double, double, double)>	signal_orientationChanged
	Emitted when the user has changed the orientation.
boost::signal< void(double, double, double)>	signal_positionChanged
	Emitted when the user has changed the orientation.

---

Detailed Description

The interface for the props widget.

---

Member Typedef Documentation

typedef std::set<DtUniqueID> makVrv::DtPropsInterface::UniqueIdSet

---

Constructor & Destructor Documentation

virtual makVrv::DtPropsInterface::~DtPropsInterface

(

)

[virtual]

DTOR.

---

Member Function Documentation

virtual void makVrv::DtPropsInterface::addPropType

(

std::string

propType

)

[pure virtual]

Add a prop type to the gui propType must be unique.

Implemented in makVrv::DtPropsWidget.

virtual void makVrv::DtPropsInterface::removePropType

(

std::string

propType

)

[pure virtual]

Remove a prop type from the gui propType must be unique.

Implemented in makVrv::DtPropsWidget.

virtual void makVrv::DtPropsInterface::addProp	(	const std::string &	propName,
		const std::string &	propType,
		DtUniqueID	id
	)		[pure virtual]

Add a prop to the gui The pair (propName, propType) must be unique.

Implemented in makVrv::DtPropsWidget.

virtual void makVrv::DtPropsInterface::removeProp	(	const std::string &	propName,
		const std::string &	propType,
		DtUniqueID	id
	)		[pure virtual]

Remove a prop from the gui The pair (propName, propType) must be unique.

Implemented in makVrv::DtPropsWidget.

virtual void makVrv::DtPropsInterface::setOpacity

(

int

opacity

)

[pure virtual]

Set the opacity in the gui.

Implemented in makVrv::DtPropsWidget.

virtual void makVrv::DtPropsInterface::setVisibility

(

int

visibility

)

[pure virtual]

Set the visibility in the gui.

Implemented in makVrv::DtPropsWidget.

virtual void makVrv::DtPropsInterface::setPropType

(

const std::string &

propType

)

[pure virtual]

Set the prop type in the gui.

Implemented in makVrv::DtPropsWidget.

virtual void makVrv::DtPropsInterface::setModelDefinition

(

const std::string &

modelDef

)

[pure virtual]

Set the model definition in the gui.

Implemented in makVrv::DtPropsWidget.

virtual void makVrv::DtPropsInterface::setPropSelected	(	DtUniqueID	id,
		bool	selected
	)		[pure virtual]

Set a prop item to be selected or unselected.

Implemented in makVrv::DtPropsWidget.

virtual void makVrv::DtPropsInterface::setPropsSelected

(

const UniqueIdSet &

)

[pure virtual]

Set a group of props selected.

Implemented in makVrv::DtPropsWidget.

virtual void makVrv::DtPropsInterface::setPropsDeselected

(

const UniqueIdSet &

)

[pure virtual]

Set a group of props deselected.

Implemented in makVrv::DtPropsWidget.

virtual void makVrv::DtPropsInterface::setPosition	(	double	x,
		double	y,
		double	z
	)		[pure virtual]

Set the position in the gui.

Implemented in makVrv::DtPropsWidget.

virtual void makVrv::DtPropsInterface::setPositionUnits

(

const DtUnicode &

units

)

[pure virtual]

Set the position units in the gui.

Implemented in makVrv::DtPropsWidget.

virtual void makVrv::DtPropsInterface::setPositionPrecisions	(	int	distDecimals,
		int	altDecimals
	)		[pure virtual]

Set the position precision in the gui.

Implemented in makVrv::DtPropsWidget.

virtual void makVrv::DtPropsInterface::setOrientation	(	const double	yaw,
		const double	pitch,
		const double	roll
	)		[pure virtual]

Set the orientation in the gui.

Implemented in makVrv::DtPropsWidget.

virtual void makVrv::DtPropsInterface::setOrientationUnits

(

const DtUnicode &

units

)

[pure virtual]

Set the orientation units in the gui.

Implemented in makVrv::DtPropsWidget.

virtual void makVrv::DtPropsInterface::setOrientationPrecision

(

int

decimals

)

[pure virtual]

Set the orientation precision in the gui.

Implemented in makVrv::DtPropsWidget.

virtual void makVrv::DtPropsInterface::setValidSchemas

(

const std::vector< std::string > &

schemaNames

)

[pure virtual]

Set the valid schema types for props.

Implemented in makVrv::DtPropsWidget.

---

Member Data Documentation

boost::signal<void (const UniqueIdSet&)> makVrv::DtPropsInterface::signal_selectionChanged

Emitted when the user has selected a prop tree item.

boost::signal<void ()> makVrv::DtPropsInterface::signal_removePropsBtnClicked

Emitted when the user has clicked the remove props button.

boost::signal<void (int)> makVrv::DtPropsInterface::signal_opacityChanged

Emitted when the user has changed the opacity.

boost::signal<void (int)> makVrv::DtPropsInterface::signal_visibilityChanged

Emitted when the user has changed the visibility.

boost::signal<void (const std::string&)> makVrv::DtPropsInterface::signal_propTypeChanged

Emitted when the user has changed the prop type.

boost::signal<void (const std::string&)> makVrv::DtPropsInterface::signal_modelDefinitionChanged

Emitted when the user has changed the Model Definition.

boost::signal<void (double, double, double)> makVrv::DtPropsInterface::signal_orientationChanged

Emitted when the user has changed the orientation.

boost::signal<void (double, double, double)> makVrv::DtPropsInterface::signal_positionChanged

Emitted when the user has changed the orientation.

---

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

• include/vrvCoreQt/DtPropsInterface.h