X3DOM.h¶

Note

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

class X3DOMParameters¶

Class data to store X3DOM view parameters.

enum class Representation: X3DOM representation type

X3DOMParameters()¶: Constructor (with default parameter settings)

void set_representation(Representation representation)¶: Set representation of object (wireframe, surface or surface_with_edges)

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

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

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

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

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

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

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

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

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

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

void set_ambient_intensity(double intensity)¶: Set the ambient lighting intensity

double get_ambient_intensity() const¶: Get the ambient lighting intensity

void set_shininess(double shininess)¶: Set the surface shininess of the object

double get_shininess() const¶: Set the surface shininess of the object

void set_transparency(double transparency)¶: Set the transparency (0-1)

double get_transparency() const¶: Get the transparency (0-1)

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)

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)

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

void set_x3d_stats(bool show)¶: Turn X3D ‘statistics’ window on/off

bool get_x3d_stats() const¶: Get the state of the ‘statistics’ window

void set_menu_display(bool show)¶: Toggle menu option

bool get_menu_display() const¶: Get the menu display state

class X3DOM¶

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

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

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

static std::string html(const Function &u, X3DOMParameters parameters = X3DOMParameters())¶: Return HTML5 string with embedded X3D for a 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

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