All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
SurgSim::Graphics::OsgScreenSpaceQuadRepresentation Class Reference

Implements the ScreenSpaceQuadRepresentation, provides the uniform 'texture' for the texture that it carries. More...

#include <SurgSim/Graphics/OsgScreenSpaceQuadRepresentation.h>

Inheritance diagram for SurgSim::Graphics::OsgScreenSpaceQuadRepresentation:
Inheritance graph
[legend]
Collaboration diagram for SurgSim::Graphics::OsgScreenSpaceQuadRepresentation:
Collaboration graph
[legend]

Public Member Functions

 OsgScreenSpaceQuadRepresentation (const std::string &name)
 Constructor. More...
 
 ~OsgScreenSpaceQuadRepresentation ()
 
virtual void setLocation (double x, double y)
 Sets the location in screen space. More...
 
virtual void getLocation (double *x, double *y)
 Gets the location in screen space. More...
 
virtual void setSize (double width, double height) override
 Sets the size for the quad in screen coordinates. More...
 
virtual void getSize (double *width, double *height) const override
 Gets the size of the quad. More...
 
virtual bool setTexture (std::shared_ptr< Texture > texture) override
 Sets a Texture for this quad, this should replace a current texture, this is a convenience function and this will use the uniform name "texture" for the uniform in this operation. More...
 
bool setTexture (std::shared_ptr< OsgTexture2d > texture)
 Sets a Texture2d for this quad, this should replace a current texture, this is a convenience function and this will use the uniform name "texture" for the uniform in this operation. More...
 
bool setTexture (std::shared_ptr< OsgTextureRectangle > texture)
 Sets a rectangular texture for this quad, this should replace a current texture, this is a convenience function and will use the uniform name "texture" for the uniform in this operation. More...
 
- Public Member Functions inherited from SurgSim::Graphics::OsgRepresentation
 OsgRepresentation (const std::string &name)
 Constructor. More...
 
virtual ~OsgRepresentation ()
 Destructor. More...
 
osg::ref_ptr< osg::Node > getOsgNode () const
 Returns the root OSG Node for this representations portion of the scene graph. More...
 
virtual void setVisible (bool visible) override
 Sets whether the representation is currently visible. More...
 
virtual bool isVisible () const override
 Gets whether the representation is currently visible. More...
 
virtual bool setMaterial (std::shared_ptr< Material > material) override
 Sets the material that defines the visual appearance of the representation. More...
 
virtual std::shared_ptr< MaterialgetMaterial () const override
 Gets the material that defines the visual appearance of the representation. More...
 
virtual void clearMaterial () override
 Removes the material from the representation. More...
 
virtual void setDrawAsWireFrame (bool val) override
 Sets the representation to render as a wire frame. More...
 
virtual bool getDrawAsWireFrame () const override
 Return if the representation is rendered as a wire frame. More...
 
virtual void update (double dt) override
 Updates the representation. More...
 
- Public Member Functions inherited from SurgSim::Graphics::Representation
 Representation (const std::string &name)
 Constructor. More...
 
virtual ~Representation ()
 Destructor. More...
 
virtual void setLocalActive (bool val) override
 Set the component's active state. More...
 
virtual bool addGroupReference (const std::string &name)
 Add a reference to a group, this will eventual add this representation to the group with the the same name. More...
 
void addGroupReferences (const std::vector< std::string > &groups)
 Adds a list of group references. More...
 
void setGroupReferences (const std::vector< std::string > &groups)
 Sets the list of group references. More...
 
void setGroupReference (const std::string &group)
 Helper functions, this clears all the references and sets, only the reference given in the parameter. More...
 
std::vector< std::string > getGroupReferences ()
 Gets group references. More...
 
bool removeGroupReference (const std::string &group)
 Function to remove an unwanted reference. More...
 
void clearGroupReferences ()
 Clear all the Group references. More...
 
- Public Member Functions inherited from SurgSim::Framework::Representation
 Representation (const std::string &name)
 Constructor. More...
 
virtual void setLocalPose (const SurgSim::Math::RigidTransform3d &pose)
 Set the pose of the representation with respect to the Scene Element. More...
 
virtual
SurgSim::Math::RigidTransform3d 
getLocalPose () const
 Get the pose of the representation with respect to the Scene Element. More...
 
virtual
SurgSim::Math::RigidTransform3d 
getPose () const
 Get the pose of the representation in world coordinates. More...
 
- Public Member Functions inherited from SurgSim::Framework::Component
 Component (const std::string &name)
 Constructor. More...
 
virtual ~Component ()
 Destructor. More...
 
std::string getName () const
 Gets component name. More...
 
void setName (const std::string &name)
 Sets the name of component. More...
 
boost::uuids::uuid getUuid () const
 Gets the id of the component. More...
 
bool isInitialized () const
 
bool initialize (const std::weak_ptr< Runtime > &runtime)
 Initialize this component, this needs to be called before wakeUp() can be called. More...
 
bool isAwake () const
 
bool wakeUp ()
 Wakeup this component, this will be called when the component is inserted into the ComponentManager that is responsible for handling this component. More...
 
void setScene (std::weak_ptr< Scene > scene)
 Sets the scene. More...
 
std::shared_ptr< ScenegetScene ()
 Gets the scene. More...
 
void setSceneElement (std::weak_ptr< SceneElement > sceneElement)
 Sets the scene element. More...
 
std::shared_ptr< SceneElementgetSceneElement ()
 Gets the scene element. More...
 
std::shared_ptr< const
SceneElement
getSceneElement () const
 Gets the scene element, constant version. More...
 
std::shared_ptr< RuntimegetRuntime () const
 Get the runtime which contains this component. More...
 
virtual std::string getClassName () const
 The class name for this class, this being the base class it should return SurgSim::Framework::Component but this would make missing implemenentations of this hard to catch, therefore this calls SURGSIM_FAILURE. More...
 
std::shared_ptr< ComponentgetSharedPtr ()
 Gets a shared pointer to this component. More...
 
bool isActive () const
 
bool isLocalActive () const
 
- Public Member Functions inherited from SurgSim::Framework::Accessible
 Accessible ()
 Default Constructor. More...
 
 ~Accessible ()
 Destructor. More...
 
template<class T >
getValue (const std::string &name) const
 Retrieves the value with the name by executing the getter if it is found and tries to convert it to the given type. More...
 
boost::any getValue (const std::string &name) const
 Retrieves the value with the name by executing the getter if it is found. More...
 
template<class T >
bool getValue (const std::string &name, T *value) const
 Retrieves the value with the name by executing the getter if it is found, and converts it to the type of the output parameter. More...
 
void setValue (const std::string &name, const boost::any &value)
 Sets a value of a property that has setter. More...
 
bool isReadable (const std::string &name) const
 Check whether a property is readable. More...
 
bool isWriteable (const std::string &name) const
 Check whether a property is writable. More...
 
void setGetter (const std::string &name, GetterType func)
 Sets a getter for a given property. More...
 
void setSetter (const std::string &name, SetterType func)
 Sets a setter for a given property. More...
 
void setAccessors (const std::string &name, GetterType getter, SetterType setter)
 Sets the accessors getter and setter in one function. More...
 
void removeAccessors (const std::string &name)
 Removes all the accessors (getter and setter) for a given property. More...
 
void forwardProperty (const std::string &name, const Accessible &target, const std::string &targetProperty)
 Adds a property with the given name that uses the targets accessors, in effect forwarding the value to the target. More...
 
void setSerializable (const std::string &name, EncoderType encoder, DecoderType decoder)
 Sets the functions used to convert data from and to a YAML::Node. More...
 
YAML::Node encode () const
 Encode this Accessible to a YAML::Node. More...
 
void decode (const YAML::Node &node)
 Decode this Accessible from a YAML::Node, will throw an exception if the data type cannot be converted. More...
 
template<>
boost::any getValue (const std::string &name) const
 
- Public Member Functions inherited from SurgSim::Graphics::ScreenSpaceQuadRepresentation
 ScreenSpaceQuadRepresentation (const std::string name)
 Constructor. More...
 
 ~ScreenSpaceQuadRepresentation ()
 

Protected Member Functions

virtual void doUpdate (double dt) override
 
virtual bool doInitialize () override
 Interface to be implemented by derived classes. More...
 
- Protected Member Functions inherited from SurgSim::Framework::Component
virtual std::shared_ptr
< PoseComponent
getPoseComponent ()
 Get the PoseComponent for this component. More...
 
virtual std::shared_ptr< const
PoseComponent
getPoseComponent () const
 Get the PoseComponent for this component, constant access. More...
 

Private Member Functions

void setTextureCoordinates (float left, float bottom, float right, float top)
 Sets texture coordinates for the quad. More...
 
bool replaceUniform (const std::string &name, std::shared_ptr< SurgSim::Graphics::UniformBase > newUniform)
 Replace a uniform in the material, will create the material if necessary. More...
 
std::shared_ptr< OsgMaterialbuildMaterial (const std::string &vertexShaderName, const std::string &fragmentShaderName)
 Utility function to build the material. More...
 

Private Attributes

osg::ref_ptr< osg::Geode > m_geode
 Local geode to contain geometry. More...
 
osg::ref_ptr< osg::Geometry > m_geometry
 Local geometry pointer. More...
 
osg::ref_ptr< osg::Projection > m_projection
 Projection matrix, needs to be updated when the view is changed. More...
 
osg::Vec3 m_scale
 Size of the quad. More...
 
std::shared_ptr< OsgUniform
< std::shared_ptr
< OsgTexture2d > > > 
m_textureUniform
 Uniform to carry the power of two texture, "texture". More...
 
std::shared_ptr< OsgUniform
< std::shared_ptr
< OsgTextureRectangle > > > 
m_rectangleTextureUniform
 Uniform to carry the rectangle texture "texture". More...
 
SurgSim::DataStructures::OptionalValue
< int > 
m_texureType
 Indicate which type of texture is currently being used. More...
 
int m_displayWidth
 
int m_displayHeight
 

Additional Inherited Members

- Public Types inherited from SurgSim::Framework::Component
typedef
SurgSim::Framework::ObjectFactory1
< SurgSim::Framework::Component,
std::string > 
FactoryType
 
- Public Types inherited from SurgSim::Framework::Accessible
typedef std::function
< boost::any(void)> 
GetterType
 
typedef std::function< void(boost::any)> SetterType
 
typedef std::function
< YAML::Node(void)> 
EncoderType
 
typedef std::function< void(const
YAML::Node *)> 
DecoderType
 
- Static Public Member Functions inherited from SurgSim::Framework::Component
static FactoryTypegetFactory ()
 
- Static Public Attributes inherited from SurgSim::Graphics::Representation
static const std::string DefaultGroupName = "__OssDefault__"
 
static const std::string DefaultHudGroupName = "__OssDefaulHud__"
 
- Protected Attributes inherited from SurgSim::Graphics::OsgRepresentation
osg::ref_ptr< osg::Switch > m_switch
 Switch used to toggle the visibility of the representation. More...
 
osg::ref_ptr
< osg::PositionAttitudeTransform > 
m_transform
 Transform used to pose the representation. More...
 
std::shared_ptr< OsgMaterialm_material
 Material defining the visual appearance of the representation. More...
 
bool m_drawAsWireFrame
 Indicates if the representation is rendered as a wireframe. More...
 
- Protected Attributes inherited from SurgSim::Graphics::Representation
bool m_isVisible
 

Detailed Description

Implements the ScreenSpaceQuadRepresentation, provides the uniform 'texture' for the texture that it carries.

Constructor & Destructor Documentation

SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::OsgScreenSpaceQuadRepresentation ( const std::string &  name)
explicit

Constructor.

SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::~OsgScreenSpaceQuadRepresentation ( )

Member Function Documentation

std::shared_ptr< OsgMaterial > SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::buildMaterial ( const std::string &  vertexShaderName,
const std::string &  fragmentShaderName 
)
private

Utility function to build the material.

Parameters
vertexShaderNamename of the vertex shader to be used, needs to be available on the path.
fragmentShaderNamename of the fragmen shader to be used, needs to be available on the path.
Returns
a valid material if all the shaders are found
bool SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::doInitialize ( )
overrideprotectedvirtual

Interface to be implemented by derived classes.

Returns
True if component is initialized successfully; otherwise, false.

Reimplemented from SurgSim::Framework::Representation.

void SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::doUpdate ( double  dt)
overrideprotectedvirtual
void SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::getLocation ( double *  x,
double *  y 
)
virtual

Gets the location in screen space.

Parameters
[out]x,yIf non-null the x and y coordinates. Throws exception otherwise.

Implements SurgSim::Graphics::ScreenSpaceQuadRepresentation.

void SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::getSize ( double *  width,
double *  height 
) const
overridevirtual

Gets the size of the quad.

Parameters
[out]widthIf non-null, the width. Throws exception otherwise.
[out]heightIf non-null, the height. Throws exception otherwise.

Implements SurgSim::Graphics::ScreenSpaceQuadRepresentation.

bool SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::replaceUniform ( const std::string &  name,
std::shared_ptr< SurgSim::Graphics::UniformBase newUniform 
)
private

Replace a uniform in the material, will create the material if necessary.

Parameters
nameThe name of the uniform to replace.
newUniformThe new uniform.
Returns
true if it succeeds, false if it fails.
void SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::setLocation ( double  x,
double  y 
)
virtual

Sets the location in screen space.

Parameters
x,yThe x and y coordinates.

Implements SurgSim::Graphics::ScreenSpaceQuadRepresentation.

void SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::setSize ( double  width,
double  height 
)
overridevirtual

Sets the size for the quad in screen coordinates.

Parameters
widthThe width of the quad in screen coordinates.
heightThe height of the quad in screen coordinates.

Implements SurgSim::Graphics::ScreenSpaceQuadRepresentation.

bool SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::setTexture ( std::shared_ptr< Texture texture)
overridevirtual

Sets a Texture for this quad, this should replace a current texture, this is a convenience function and this will use the uniform name "texture" for the uniform in this operation.

This can be accomplished from the outside as well by using the material.

Parameters
textureThe texture to be set on the quad.
Returns
true if it succeeds, false if it fails.

Implements SurgSim::Graphics::ScreenSpaceQuadRepresentation.

bool SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::setTexture ( std::shared_ptr< OsgTexture2d texture)

Sets a Texture2d for this quad, this should replace a current texture, this is a convenience function and this will use the uniform name "texture" for the uniform in this operation.

This can be accomplished from the outside as well by using the material.

Parameters
textureThe texture to be set on the quad.
Returns
true if it succeeds, false if it fails.
bool SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::setTexture ( std::shared_ptr< OsgTextureRectangle texture)

Sets a rectangular texture for this quad, this should replace a current texture, this is a convenience function and will use the uniform name "texture" for the uniform in this operation.

Exceptions
SurgSim::Framework::AssertionFailureif the type of the texture is changed during runtime.
Parameters
textureThe texture to be set on the quad.
Returns
true if it succeeds, false if it fails.
void SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::setTextureCoordinates ( float  left,
float  bottom,
float  right,
float  top 
)
private

Sets texture coordinates for the quad.

Parameters
left,bottom,right,topThe extents for the texture coordinates for the corners of the quad.

Member Data Documentation

int SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::m_displayHeight
private

Cached view extensions

int SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::m_displayWidth
private

Cached view extensions

osg::ref_ptr<osg::Geode> SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::m_geode
private

Local geode to contain geometry.

osg::ref_ptr<osg::Geometry> SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::m_geometry
private

Local geometry pointer.

osg::ref_ptr<osg::Projection> SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::m_projection
private

Projection matrix, needs to be updated when the view is changed.

std::shared_ptr<OsgUniform<std::shared_ptr<OsgTextureRectangle> > > SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::m_rectangleTextureUniform
private

Uniform to carry the rectangle texture "texture".

osg::Vec3 SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::m_scale
private

Size of the quad.

std::shared_ptr<OsgUniform<std::shared_ptr<OsgTexture2d> > > SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::m_textureUniform
private

Uniform to carry the power of two texture, "texture".

SurgSim::DataStructures::OptionalValue<int> SurgSim::Graphics::OsgScreenSpaceQuadRepresentation::m_texureType
private

Indicate which type of texture is currently being used.


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