SOFA API  3944ba52
Open source framework for multi-physics simuation
sofa::component::visualmodel Namespace Reference

Classes

class  BaseCamera
 
class  Camera
 
class  ClipPlane
 
class  CompositingVisualLoop
 
class  DataDisplay
 
class  DirectionalLight
 
class  InteractiveCamera
 
class  Light
 Utility to cast Light into a Opengl scene. More...
 
class  LightManager
 Utility to manage lights into an Opengl scene. More...
 
class  MergeVisualModels
 
class  OglAttribute
 
class  OglColorMap
 
class  OglCylinderModel
 
class  OglFloat2Attribute
 
class  OglFloat2Variable
 
class  OglFloat3Attribute
 
class  OglFloat3Variable
 
class  OglFloat4Attribute
 
class  OglFloat4Variable
 
class  OglFloatAttribute
 
class  OglFloatVariable
 
class  OglFloatVector2Variable
 
class  OglFloatVector3Variable
 
class  OglFloatVector4Variable
 
class  OglFloatVectorVariable
 
class  OglGrid
 
class  OglInt2Attribute
 
class  OglInt2Variable
 
class  OglInt3Attribute
 
class  OglInt3Variable
 
class  OglInt4Attribute
 
class  OglInt4Variable
 
class  OglIntAttribute
 
class  OglIntVariable
 
class  OglIntVector2Variable
 
class  OglIntVector3Variable
 
class  OglIntVector4Variable
 
class  OglIntVectorVariable
 
class  OglLabel
 
class  OglLineAxis
 
class  OglMatrix2Variable
 
class  OglMatrix2x3Variable
 
class  OglMatrix2x4Variable
 
class  OglMatrix3Variable
 
class  OglMatrix3x2Variable
 
class  OglMatrix3x4Variable
 
class  OglMatrix4Variable
 
class  OglMatrix4VectorVariable
 
class  OglMatrix4x2Variable
 
class  OglMatrix4x3Variable
 
class  OglModel
 Main class for rendering 3D model in SOFA. More...
 
class  OglOITShader
 
class  OglRenderingSRGB
 The utility to enable/disable sRGB rendering. More...
 
class  OglSceneFrame
 
class  OglShader
 Utility to use shader for a visual model in OpenGL. More...
 
class  OglShaderDefineMacro
 
class  OglShaderElement
 Abstract class which defines a element to be used with a OglShader. More...
 
class  OglShaderMacro
 Small class to define macro into an OglShader. More...
 
class  OglShaderVisualModel
 
class  OglShadowShader
 
class  OglTexture
 Defines an uniform sampler (texture) for a OglShader. More...
 
class  OglTexture2D
 
class  OglTexturePointer
 Defines an uniform sampler (texture) for a OglShader. More...
 
class  OglUInt2Attribute
 
class  OglUInt3Attribute
 
class  OglUInt4Attribute
 
class  OglUIntAttribute
 
class  OglVariable
 Defines an uniform variable for a OglShader. More...
 
class  OglViewport
 
class  OrderIndependentTransparencyManager
 Utility to manage transparency (translucency) into an Opengl scene. More...
 
class  PointSplatModel
 
class  PositionalLight
 
class  PostProcessManager
 
class  RecordedCamera
 
class  SlicedVolumetricModel
 
class  SpotLight
 
class  Vec3State
 
class  Visual3DText
 Draw camera-oriented (billboard) 3D text. More...
 
class  VisualManagerPass
 Render pass element: render the relevant tagged objects in a FBO. More...
 
class  VisualManagerSecondaryPass
 Render pass element: render the relevant tagged objects in a FBO. More...
 
class  VisualModelImpl
 Abstract class which implements partially VisualModel. More...
 
class  VisualModelPointHandler
 
class  VisualOITDrawVisitor
 
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::defaulttype::Vec< 3, GLfloat > GLVec3f
 

Functions

template<class T >
const T * getData (const sofa::helper::vector< T > &v)
 
void glVertex3v (const float *d)
 
void glVertex3v (const double *d)
 
template<class T >
GLuint glType ()
 
template<>
GLuint glType< double > ()
 
template<>
GLuint glType< float > ()
 
template<class InType , class OutType >
void copyVector (const InType &src, OutType &dst)
 
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 (TiXmlElement *root, core::objectmodel::BaseData &data, const std::string &comment)
 
bool BaseCameraXMLImportSingleParameter (TiXmlElement *root, core::objectmodel::BaseData &data, BaseCamera *c)
 
helper::WriteAccessor< sofa::core::visual::DisplayFlagsaddVisualStyle (simulation::Node::SPtr node)
 

Variables

int RecordedCameraClass
 
int Visual3DTextClass
 
int VisualTransformClass
 
int ClipPlaneClass
 
int CompositingVisualLoopClass
 
int DataDisplayClass
 
int DirectionalLightClass
 
int PositionalLightClass
 
int SpotLightClass
 
int LightManagerClass
 
int MergeVisualModelsClass
 
int OglFloatAttributeClass = core::RegisterObject ( "OglFloatAttribute" ).add< OglFloatAttribute >()
 
int OglFloat2AttributeClass = core::RegisterObject ( "OglFloat2Attribute" ).add< OglFloat2Attribute >()
 
int OglFloat3AttributeClass = core::RegisterObject ( "OglFloat3Attribute" ).add< OglFloat3Attribute >()
 
int OglFloat4AttributeClass = core::RegisterObject ( "OglFloat4Attribute" ).add< OglFloat4Attribute >()
 
int OglIntAttributeClass = core::RegisterObject ( "OglIntAttribute" ).add< OglIntAttribute >()
 
int OglInt2AttributeClass = core::RegisterObject ( "OglInt2Attribute" ).add< OglInt2Attribute >()
 
int OglInt3AttributeClass = core::RegisterObject ( "OglInt3Attribute" ).add< OglInt3Attribute >()
 
int OglInt4AttributeClass = core::RegisterObject ( "OglInt4Attribute" ).add< OglInt4Attribute >()
 
int OglUIntAttributeClass = core::RegisterObject ( "OglUIntAttribute" ).add< OglUIntAttribute >()
 
int OglUInt2AttributeClass = core::RegisterObject ( "OglUInt2Attribute" ).add< OglUInt2Attribute >()
 
int OglUInt3AttributeClass = core::RegisterObject ( "OglUInt3Attribute" ).add< OglUInt3Attribute >()
 
int OglUInt4AttributeClass = core::RegisterObject ( "OglUInt4Attribute" ).add< OglUInt4Attribute >()
 
int OglColorMapClass
 
int OglCylinderModelClass
 
int OglGridClass
 
int OglLabelClass
 
int OglLineAxisClass
 
int OglModelClass
 
int OglOITShaderClass
 
int OglRenderingSRGBClass
 
int OglSceneFrameClass
 
int OglShaderClass
 
int OglShaderDefineMacroClass
 
int OglShaderVisualModelClass
 
int OglShadowShaderClass
 
int OglTextureClass = core::RegisterObject("OglTexture").add< OglTexture >()
 
int OglTexture2DClass = core::RegisterObject("OglTexture2D").add< OglTexture2D >()
 
int OglTexturePointerClass = core::RegisterObject("OglTexturePointer").add< OglTexturePointer >()
 
int OglIntVariableClass
 
int OglInt2VariableClass
 
int OglInt3VariableClass
 
int OglInt4VariableClass
 
int OglFloatVariableClass
 
int OglFloat2VariableClass
 
int OglFloat3VariableClass
 
int OglFloat4VariableClass
 
int OglIntVectorVariableClass
 
int OglIntVector2VariableClass
 
int OglIntVector3VariableClass
 
int OglIntVector4VariableClass
 
int OglFloatVectorVariableClass
 
int OglFloatVector2VariableClass
 
int OglFloatVector3VariableClass
 
int OglFloatVector4VariableClass
 
int OglMatrix2VariableClass
 
int OglMatrix3VariableClass
 
int OglMatrix4VariableClass
 
int OglMatrix2x3VariableClass
 
int OglMatrix3x2VariableClass
 
int OglMatrix2x4VariableClass
 
int OglMatrix4x2VariableClass
 
int OglMatrix3x4VariableClass
 
int OglMatrix4x3VariableClass
 
int OglMatrix4VectorVariableClass
 
int OglViewportClass
 
int OrderIndependentTransparencyManagerClass
 
int PointSplatModelClass
 
int PostProcessManagerClass
 
int SlicedVolumetricModelClass
 
int VisualManagerPassClass
 
int VisualManagerSecondaryPassClass
 
int CameraClass
 
int InteractiveCameraClass
 
int VisualModelImplClass
 
int VisualStyleClass
 

Typedef Documentation

typedef sofa::defaulttype::Vec<3,GLfloat> sofa::component::visualmodel::GLVec3f

Function Documentation

SOFA_BASE_VISUAL_API helper::WriteAccessor< sofa::core::visual::DisplayFlags > sofa::component::visualmodel::addVisualStyle ( simulation::Node::SPtr  node)
void sofa::component::visualmodel::BaseCameraXMLExportSingleParameter ( TiXmlElement *  root,
core::objectmodel::BaseData data,
const std::string &  comment 
)
bool sofa::component::visualmodel::BaseCameraXMLImportSingleParameter ( TiXmlElement *  root,
core::objectmodel::BaseData data,
BaseCamera c 
)
template<class InType , class OutType >
void sofa::component::visualmodel::copyVector ( const InType &  src,
OutType &  dst 
)
template<class T >
const T* sofa::component::visualmodel::getData ( const sofa::helper::vector< T > &  v)
template<class Real >
bool sofa::component::visualmodel::glhUnProjectf ( Real  winx,
Real  winy,
Real  winz,
Real modelview,
Real projection,
const core::visual::VisualParams::Viewport viewport,
Real objectCoordinate 
)
template<class T >
GLuint sofa::component::visualmodel::glType ( )
void sofa::component::visualmodel::glVertex3v ( const float d)
void sofa::component::visualmodel::glVertex3v ( const double d)

Variable Documentation

int sofa::component::visualmodel::CameraClass
Initial value:
= core::RegisterObject("A Camera that render the scene from a given location & orientation.")
.add<Camera>()
int sofa::component::visualmodel::ClipPlaneClass
Initial value:
= core::RegisterObject("OpenGL Clipping Plane")
.add< ClipPlane >()
int sofa::component::visualmodel::CompositingVisualLoopClass
Initial value:
= core::RegisterObject("Visual loop enabling multipass rendering. Needs multiple fbo data and a compositing shader")
.add< CompositingVisualLoop >()
int sofa::component::visualmodel::DataDisplayClass
Initial value:
= core::RegisterObject("Rendering of meshes colored by data")
.add< DataDisplay >()
int sofa::component::visualmodel::DirectionalLightClass
Initial value:
= core::RegisterObject("A directional light illuminating the scene with parallel rays of light (can cast shadows).")
.add< DirectionalLight >()
int sofa::component::visualmodel::InteractiveCameraClass
Initial value:
= core::RegisterObject("InteractiveCamera")
.add< InteractiveCamera >()
int sofa::component::visualmodel::LightManagerClass
Initial value:
("Manage a set of lights that can cast hard and soft shadows.Soft Shadows is done using Variance Shadow Mapping "
"(http://developer.download.nvidia.com/SDK/10.5/direct3d/Source/VarianceShadowMapping/Doc/VarianceShadowMapping.pdf)")
.add< LightManager >()
RegisterObject & add(bool defaultTemplate=false)
Definition: ObjectFactory.h:292
Helper class used to register a class in the ObjectFactory.
Definition: ObjectFactory.h:260
int sofa::component::visualmodel::MergeVisualModelsClass
Initial value:
= core::RegisterObject("Merge several visual models")
.add< MergeVisualModels >(true)
int sofa::component::visualmodel::OglColorMapClass
Initial value:
= core::RegisterObject("Provides color palette and support for conversion of numbers to colors.")
.add< OglColorMap >()
.addAlias("ColorMap")
int sofa::component::visualmodel::OglCylinderModelClass
Initial value:
= core::RegisterObject("A simple visualization for set of cylinder.")
.add< OglCylinderModel >()
int sofa::component::visualmodel::OglFloat2AttributeClass = core::RegisterObject ( "OglFloat2Attribute" ).add< OglFloat2Attribute >()
int sofa::component::visualmodel::OglFloat2VariableClass
Initial value:
= core::RegisterObject("OglFloat2Variable")
.add< OglFloat2Variable >()
int sofa::component::visualmodel::OglFloat3AttributeClass = core::RegisterObject ( "OglFloat3Attribute" ).add< OglFloat3Attribute >()
int sofa::component::visualmodel::OglFloat3VariableClass
Initial value:
= core::RegisterObject("OglFloat3Variable")
.add< OglFloat3Variable >()
int sofa::component::visualmodel::OglFloat4AttributeClass = core::RegisterObject ( "OglFloat4Attribute" ).add< OglFloat4Attribute >()
int sofa::component::visualmodel::OglFloat4VariableClass
Initial value:
= core::RegisterObject("OglFloat4Variable")
.add< OglFloat4Variable >()
int sofa::component::visualmodel::OglFloatAttributeClass = core::RegisterObject ( "OglFloatAttribute" ).add< OglFloatAttribute >()
int sofa::component::visualmodel::OglFloatVariableClass
Initial value:
= core::RegisterObject("OglFloatVariable")
.add< OglFloatVariable >()

SINGLE FLOAT VARIABLE

int sofa::component::visualmodel::OglFloatVector2VariableClass
Initial value:
= core::RegisterObject("OglFloatVector2Variable")
.add< OglFloatVector2Variable >()
int sofa::component::visualmodel::OglFloatVector3VariableClass
Initial value:
= core::RegisterObject("OglFloatVector3Variable")
.add< OglFloatVector3Variable >()
int sofa::component::visualmodel::OglFloatVector4VariableClass
Initial value:
= core::RegisterObject("OglFloatVector4Variable")
.add< OglFloatVector4Variable >()
int sofa::component::visualmodel::OglFloatVectorVariableClass
Initial value:
= core::RegisterObject("OglFloatVectorVariable")
.add< OglFloatVectorVariable >()

FLOAT VECTOR VARIABLE

int sofa::component::visualmodel::OglGridClass
Initial value:
= core::RegisterObject("Display a simple grid")
.add< component::visualmodel::OglGrid>()
int sofa::component::visualmodel::OglInt2AttributeClass = core::RegisterObject ( "OglInt2Attribute" ).add< OglInt2Attribute >()
int sofa::component::visualmodel::OglInt2VariableClass
Initial value:
= core::RegisterObject("OglInt2Variable")
.add< OglInt2Variable >()
int sofa::component::visualmodel::OglInt3AttributeClass = core::RegisterObject ( "OglInt3Attribute" ).add< OglInt3Attribute >()
int sofa::component::visualmodel::OglInt3VariableClass
Initial value:
= core::RegisterObject("OglInt3Variable")
.add< OglInt3Variable >()
int sofa::component::visualmodel::OglInt4AttributeClass = core::RegisterObject ( "OglInt4Attribute" ).add< OglInt4Attribute >()
int sofa::component::visualmodel::OglInt4VariableClass
Initial value:
= core::RegisterObject("OglInt4Variable")
.add< OglInt4Variable >()
int sofa::component::visualmodel::OglIntAttributeClass = core::RegisterObject ( "OglIntAttribute" ).add< OglIntAttribute >()
int sofa::component::visualmodel::OglIntVariableClass
Initial value:
= core::RegisterObject("OglIntVariable")
.add< OglIntVariable >()

SINGLE INT VARIABLE

int sofa::component::visualmodel::OglIntVector2VariableClass
Initial value:
= core::RegisterObject("OglIntVector2Variable")
.add< OglIntVector2Variable >()
int sofa::component::visualmodel::OglIntVector3VariableClass
Initial value:
= core::RegisterObject("OglIntVector3Variable")
.add< OglIntVector3Variable >()
int sofa::component::visualmodel::OglIntVector4VariableClass
Initial value:
= core::RegisterObject("OglIntVector4Variable")
.add< OglIntVector4Variable >()
int sofa::component::visualmodel::OglIntVectorVariableClass
Initial value:
= core::RegisterObject("OglIntVectorVariable")
.add< OglIntVectorVariable >()

INT VECTOR VARIABLE

int sofa::component::visualmodel::OglLabelClass
Initial value:
= core::RegisterObject("Display 2D text in the viewport.")
.add< OglLabel >()
int sofa::component::visualmodel::OglLineAxisClass
Initial value:
= core::RegisterObject("Display scene axis")
.add< component::visualmodel::OglLineAxis >()
int sofa::component::visualmodel::OglMatrix2VariableClass
Initial value:
= core::RegisterObject("OglMatrix2Variable")
.add< OglMatrix2Variable >()

Matrix VARIABLE

int sofa::component::visualmodel::OglMatrix2x3VariableClass
Initial value:
= core::RegisterObject("OglMatrix2x3Variable")
.add< OglMatrix2x3Variable >()
int sofa::component::visualmodel::OglMatrix2x4VariableClass
Initial value:
= core::RegisterObject("OglMatrix2x4Variable")
.add< OglMatrix2x4Variable >()
int sofa::component::visualmodel::OglMatrix3VariableClass
Initial value:
= core::RegisterObject("OglMatrix3Variable")
.add< OglMatrix3Variable >()
int sofa::component::visualmodel::OglMatrix3x2VariableClass
Initial value:
= core::RegisterObject("OglMatrix3x2Variable")
.add< OglMatrix3x2Variable >()
int sofa::component::visualmodel::OglMatrix3x4VariableClass
Initial value:
= core::RegisterObject("OglMatrix3x4Variable")
.add< OglMatrix3x4Variable >()
int sofa::component::visualmodel::OglMatrix4VariableClass
Initial value:
= core::RegisterObject("OglMatrix4Variable")
.add< OglMatrix4Variable >()
int sofa::component::visualmodel::OglMatrix4VectorVariableClass
Initial value:
= core::RegisterObject("OglMatrix4VectorVariable")
.add< OglMatrix4VectorVariable >()

Matrix vector VARIABLE

int sofa::component::visualmodel::OglMatrix4x2VariableClass
Initial value:
= core::RegisterObject("OglMatrix4x2Variable")
.add< OglMatrix4x2Variable >()
int sofa::component::visualmodel::OglMatrix4x3VariableClass
Initial value:
= core::RegisterObject("OglMatrix4x3Variable")
.add< OglMatrix4x3Variable >()
int sofa::component::visualmodel::OglModelClass
Initial value:
= core::RegisterObject("Generic visual model for OpenGL display")
Main class for rendering 3D model in SOFA.
Definition: OglModel.h:55
int sofa::component::visualmodel::OglOITShaderClass
Initial value:
= core::RegisterObject("OglOITShader")
.add< OglOITShader >()
int sofa::component::visualmodel::OglRenderingSRGBClass
Initial value:
= core::RegisterObject("OglRenderingSRGB")
.add< OglRenderingSRGB >()
int sofa::component::visualmodel::OglSceneFrameClass
Initial value:
= core::RegisterObject("Display a frame at the corner of the scene view")
.add< OglSceneFrame >()
int sofa::component::visualmodel::OglShaderClass
Initial value:
= core::RegisterObject("OglShader")
.add< OglShader >()
int sofa::component::visualmodel::OglShaderDefineMacroClass
Initial value:
= core::RegisterObject("OglShaderDefineMacro")
.add< OglShaderDefineMacro >()
int sofa::component::visualmodel::OglShaderVisualModelClass
Initial value:
= core::RegisterObject("Visual model for OpenGL display using Glew extensions")
.add< OglShaderVisualModel >()
int sofa::component::visualmodel::OglShadowShaderClass
Initial value:
= core::RegisterObject("This component sets the shader system responsible of the shadowing.")
.add< OglShadowShader >()
int sofa::component::visualmodel::OglTexture2DClass = core::RegisterObject("OglTexture2D").add< OglTexture2D >()
int sofa::component::visualmodel::OglTextureClass = core::RegisterObject("OglTexture").add< OglTexture >()
int sofa::component::visualmodel::OglTexturePointerClass = core::RegisterObject("OglTexturePointer").add< OglTexturePointer >()
int sofa::component::visualmodel::OglUInt2AttributeClass = core::RegisterObject ( "OglUInt2Attribute" ).add< OglUInt2Attribute >()
int sofa::component::visualmodel::OglUInt3AttributeClass = core::RegisterObject ( "OglUInt3Attribute" ).add< OglUInt3Attribute >()
int sofa::component::visualmodel::OglUInt4AttributeClass = core::RegisterObject ( "OglUInt4Attribute" ).add< OglUInt4Attribute >()
int sofa::component::visualmodel::OglUIntAttributeClass = core::RegisterObject ( "OglUIntAttribute" ).add< OglUIntAttribute >()
int sofa::component::visualmodel::OglViewportClass
Initial value:
= core::RegisterObject("OglViewport")
.add< OglViewport >()
int sofa::component::visualmodel::OrderIndependentTransparencyManagerClass
Initial value:
= core::RegisterObject("OrderIndependentTransparencyManager")
.add< OrderIndependentTransparencyManager >()
int sofa::component::visualmodel::PointSplatModelClass
Initial value:
= core::RegisterObject("A simple visualization for a cloud of points.")
.add< PointSplatModel >()
.addAlias("PointSplat")
int sofa::component::visualmodel::PositionalLightClass
Initial value:
= core::RegisterObject("A positional light illuminating the scene."
"The light has a location from which the ray are starting in all direction (cannot cast shadows for now)")
.add< PositionalLight >()
int sofa::component::visualmodel::PostProcessManagerClass
Initial value:
= core::RegisterObject("PostProcessManager")
.add< PostProcessManager >()
int sofa::component::visualmodel::RecordedCameraClass
Initial value:
= core::RegisterObject("A camera that is moving along a predetermined path.")
.add< RecordedCamera >()
int sofa::component::visualmodel::SlicedVolumetricModelClass
Initial value:
= core::RegisterObject("A simple visualization for a cloud of points.")
.add< SlicedVolumetricModel >()
int sofa::component::visualmodel::SpotLightClass
Initial value:
= core::RegisterObject("A spot light illuminating the scene."
"The light has a location and a illumination cone restricting the directions"
"taken by the rays of light (can cast shadows).")
.add< SpotLight >()
int sofa::component::visualmodel::Visual3DTextClass
Initial value:
= core::RegisterObject("Display 3D camera-oriented text")
.add< Visual3DText >()
int sofa::component::visualmodel::VisualManagerPassClass
Initial value:
= core::RegisterObject("VisualManagerPass")
.add< VisualManagerPass >()
int sofa::component::visualmodel::VisualManagerSecondaryPassClass
Initial value:
= core::RegisterObject("VisualManagerSecondaryPass")
.add< VisualManagerSecondaryPass >()
int sofa::component::visualmodel::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")
int sofa::component::visualmodel::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>()
int sofa::component::visualmodel::VisualTransformClass
Initial value:
.add<VisualTransform>()
RegisterObject & add(bool defaultTemplate=false)
Definition: ObjectFactory.h:292
Helper class used to register a class in the ObjectFactory.
Definition: ObjectFactory.h:260