.. Documentation for the header file dolfin/io/X3DOM.h

.. _programmers_reference_cpp_io_x3dom:

X3DOM.h
=======

.. note::
    
    The documentation on this page was automatically extracted from the
    DOLFIN C++ code and may need to be edited or expanded.
    

.. cpp:class:: X3DOMParameters

    Class data to store X3DOM view parameters.


    .. cpp:function:: enum class Representation
    
        X3DOM representation type


    .. cpp:function:: X3DOMParameters()
    
        Constructor (with default parameter settings)


    .. cpp:function:: void set_representation(Representation representation)
    
        Set representation of object (wireframe, surface or
        surface_with_edges)


    .. cpp:function:: Representation get_representation() const
    
        Get the current representation of the object (wireframe,
        surface or surface_with_edges)


    .. cpp:function:: std::array<double, 2> get_viewport_size() const
    
        Get the size of the viewport


    .. cpp:function:: void set_diffuse_color(std::array<double, 3> rgb)
    
        Set the RGB color of the object


    .. cpp:function:: std::array<double, 3> get_diffuse_color() const
    
        Get the RGB diffuse color of the object


    .. cpp:function:: void set_emissive_color(std::array<double, 3> rgb)
    
        Set the RGB emissive color


    .. cpp:function:: std::array<double, 3> get_emissive_color() const
    
        Get the RGB emissive color


    .. cpp:function:: void set_specular_color(std::array<double, 3> rgb)
    
        Set the RGB specular color


    .. cpp:function:: std::array<double, 3> get_specular_color() const
    
        Get the RGB specular color


    .. cpp:function:: void set_background_color(std::array<double, 3> rgb)
    
        Set background RGB color


    .. cpp:function:: std::array<double, 3> get_background_color() const
    
        Get background RGB color


    .. cpp:function:: void set_ambient_intensity(double intensity)
    
        Set the ambient lighting intensity


    .. cpp:function:: double get_ambient_intensity() const
    
        Get the ambient lighting intensity


    .. cpp:function:: void set_shininess(double shininess)
    
        Set the surface shininess of the object


    .. cpp:function:: double get_shininess() const
    
        Set the surface shininess of the object


    .. cpp:function:: void set_transparency(double transparency)
    
        Set the transparency (0-1)


    .. cpp:function:: double get_transparency() const
    
        Get the transparency (0-1)


    .. cpp:function:: void set_color_map(const std::vector<double>& color_data)
    
        Set the color map by supplying a vector of 768 values
        (256*RGB) (using std::vector for Python compatibility via
        SWIG)


    .. cpp:function:: std::vector<double> get_color_map() const
    
        Get the color map as a vector of 768 values (256*RGB) (using
        std::vector for Python compatibility via SWIG)


    .. cpp:function:: boost::multi_array<float, 2> get_color_map_array() const
    
        Get the color map as a boost::multi_array (256x3)


    .. cpp:function:: void set_x3d_stats(bool show)
    
        Turn X3D 'statistics' window on/off


    .. cpp:function:: bool get_x3d_stats() const
    
        Get the state of the 'statistics' window


    .. cpp:function:: void set_menu_display(bool show)
    
        Toggle menu option


    .. cpp:function:: bool get_menu_display() const
    
        Get the menu display state


.. cpp:class:: X3DOM

    .. cpp:function:: static std::string str(const Mesh& mesh, X3DOMParameters parameters=X3DOMParameters())
    
        Return X3D string for a Mesh


    .. cpp:function:: static std::string str(const Function& u, X3DOMParameters parameters=X3DOMParameters())
    
        Return X3D string for a Function


    .. cpp:function:: static std::string html(const Mesh& mesh, X3DOMParameters parameters=X3DOMParameters())
    
        Return HTML5 string with embedded X3D for a Mesh


    .. cpp:function:: static std::string html(const Function& u, X3DOMParameters parameters=X3DOMParameters())
    
        Return HTML5 string with embedded X3D for a Function


    .. cpp:function:: static void build_x3dom_tree(pugi::xml_document& xml_doc, const Mesh& mesh, const X3DOMParameters& parameters=X3DOMParameters())
    
        Build X3DOM pugixml tree for a Mesh


    .. cpp:function:: static void build_x3dom_tree(pugi::xml_document& xml_doc, const Function& u, const X3DOMParameters& parameters=X3DOMParameters())
    
        Build X3DOM pugixml tree for a Function