sofa::component::visual Namespace Reference

Classes
class	BaseCamera
class	Camera
class	InteractiveCamera
class	LineAxis
class	RecordedCamera
class	TrailRenderer
class	Visual3DText
	Draw camera-oriented (billboard) 3D text. More...
class	VisualGrid
class	VisualModelImpl
	Abstract class which implements partially VisualModel. More...
class	VisualStyle
	VisualStyle component controls the DisplayFlags state embedded in the VisualParams for the current subgraph. It merges the DisplayFlags conveyed by the VisualParams with its own DisplayFlags. More...
class	VisualTransform

Typedefs
typedef sofa::core::visual::VisualState< defaulttype::Vec3Types >	Vec3State

Functions
template<class Real >
bool	glhUnProjectf (Real winx, Real winy, Real winz, Real *modelview, Real *projection, const core::visual::VisualParams::Viewport &viewport, Real *objectCoordinate)
void	BaseCameraXMLExportSingleParameter (tinyxml2::XMLElement *root, core::objectmodel::BaseData &data, const std::string &comment)
bool	BaseCameraXMLImportSingleParameter (tinyxml2::XMLElement *root, core::objectmodel::BaseData &data, BaseCamera *c)
SOFA_EXPORT_DYNAMIC_LIBRARY void	initExternalModule ()
SOFA_EXPORT_DYNAMIC_LIBRARY const char *	getModuleName ()
SOFA_EXPORT_DYNAMIC_LIBRARY const char *	getModuleVersion ()
SOFA_EXPORT_DYNAMIC_LIBRARY const char *	getModuleComponentList ()
void	init ()
helper::WriteAccessor< sofa::core::visual::DisplayFlags >	addVisualStyle (simulation::Node::SPtr node)
SOFA_COMPONENT_VISUAL_API helper::WriteAccessor< sofa::core::visual::DisplayFlags >	addVisualStyle (simulation::NodeSPtr node)

Variables
int	CameraClass
int	InteractiveCameraClass
int	LineAxisClass
int	RecordedCameraClass
int	TrailRendererClass
int	Visual3DTextClass
int	VisualGridClass
int	VisualModelImplClass
int	VisualStyleClass
int	VisualTransformClass

Typedef Documentation

Vec3State

typedef sofa::core::visual::VisualState<defaulttype::Vec3Types> sofa::component::visual::Vec3State

Function Documentation

addVisualStyle() [1/2]

helper::WriteAccessor<sofa::core::visual::DisplayFlags> sofa::component::visual::addVisualStyle

(

simulation::Node::SPtr

node

)

addVisualStyle() [2/2]

SOFA_COMPONENT_VISUAL_API helper::WriteAccessor<sofa::core::visual::DisplayFlags> sofa::component::visual::addVisualStyle

(

simulation::NodeSPtr

node

)

BaseCameraXMLExportSingleParameter()

void sofa::component::visual::BaseCameraXMLExportSingleParameter	(	tinyxml2::XMLElement *	root,
		core::objectmodel::BaseData &	data,
		const std::string &	comment
	)

BaseCameraXMLImportSingleParameter()

bool sofa::component::visual::BaseCameraXMLImportSingleParameter	(	tinyxml2::XMLElement *	root,
		core::objectmodel::BaseData &	data,
		BaseCamera *	c
	)

getModuleComponentList()

const char * sofa::component::visual::getModuleComponentList

(

)

getModuleName()

const char * sofa::component::visual::getModuleName

(

)

getModuleVersion()

const char * sofa::component::visual::getModuleVersion

(

)

glhUnProjectf()

template<class Real >

bool sofa::component::visual::glhUnProjectf	(	Real	winx,
		Real	winy,
		Real	winz,
		Real *	modelview,
		Real *	projection,
		const core::visual::VisualParams::Viewport &	viewport,
		Real *	objectCoordinate
	)

init()

SOFA_COMPONENT_VISUAL_API void sofa::component::visual::init

(

)

initExternalModule()

void sofa::component::visual::initExternalModule

(

)

Variable Documentation

CameraClass

int sofa::component::visual::CameraClass

Initial value:

= core::RegisterObject("A Camera that render the scene from a given location & orientation.")
                    .add<Camera>()

InteractiveCameraClass

int sofa::component::visual::InteractiveCameraClass

Initial value:

= core::RegisterObject("InteractiveCamera")
        .add< InteractiveCamera >()

LineAxisClass

int sofa::component::visual::LineAxisClass

Initial value:

= core::RegisterObject("Display scene axis")
        .add< LineAxis >()

RecordedCameraClass

int sofa::component::visual::RecordedCameraClass

Initial value:

= core::RegisterObject("A camera that is moving along a predetermined path.")
        .add< RecordedCamera >()

TrailRendererClass

int sofa::component::visual::TrailRendererClass

Initial value:

= sofa::core::RegisterObject("Render a trail behind particles")
    .add<TrailRenderer<defaulttype::Vec3Types>>()
    .add<TrailRenderer<defaulttype::Rigid3Types>>()

Visual3DTextClass

int sofa::component::visual::Visual3DTextClass

Initial value:

= core::RegisterObject("Display 3D camera-oriented text")
        .add< Visual3DText >()

VisualGridClass

int sofa::component::visual::VisualGridClass

Initial value:

= core::RegisterObject("Display a simple grid")
        .add< VisualGrid>()

VisualModelImplClass

int sofa::component::visual::VisualModelImplClass

Initial value:

= core::RegisterObject("Generic visual model. If a viewer is active it will replace the VisualModel alias, otherwise nothing will be displayed.")
        .add< VisualModelImpl >()
        .addAlias("VisualModel")

VisualStyleClass

int sofa::component::visual::VisualStyleClass

Initial value:

= core::RegisterObject("Edit the visual style.\n Allowed values for displayFlags data are a combination of the following:\n\
showAll, hideAll,\n\
    showVisual, hideVisual,\n\
        showVisualModels, hideVisualModels,\n\
    showBehavior, hideBehavior,\n\
        showBehaviorModels, hideBehaviorModels,\n\
        showForceFields, hideForceFields,\n\
        showInteractionForceFields, hideInteractionForceFields\n\
    showMapping, hideMapping\n\
        showMappings, hideMappings\n\
        showMechanicalMappings, hideMechanicalMappings\n\
    showCollision, hideCollision\n\
        showCollisionModels, hideCollisionModels\n\
        showBoundingCollisionModels, hideBoundingCollisionModels\n\
    showOptions hideOptions\n\
        showRendering hideRendering\n\
        showNormals hideNormals\n\
        showWireframe hideWireframe").add<VisualStyle>()

VisualTransformClass

int sofa::component::visual::VisualTransformClass

Initial value:

= sofa::core::RegisterObject("TODO")
        .add<VisualTransform>()