Interactive.src.ViewElements.Drawables

Drawable elements and base classes

Information

Drawables package

Drawables package includes the container elements and the base classes that the library developer has to extend to create new container elements.

Package Content

Name	Description
Drawable	Base class of the classes describing drawable elements
Shape	Base class of the classes describing 3-D source drawables
Sphere	Sphere. Var. linked to the model: color[11], Position[3], Origin[3], Degrees[3] and Radius
Text	Displays a string. Var. linked to the model: color[11], Position[3], Origin[3], Degrees[3].
Arrow	Arrow. Var. linked to the model: color[11], Position[3], Origin[3], Degrees[3], scale
Trail	Trail. Var. linked to the model: point[2]
Cube	Cube. Var. linked to the model: color[11], Position[3], Origin[3], Degrees[3], Length[3]
Cylinder	Cylinder. Var. linked to the model: color[11], Position[3], Origin[3], Degrees[3], Radius, Height
RegularPolygon	Regular polygon inscribed in a circle. Var. linked to the model: color[11], Position[3], Origin[3], Degrees[3], Normal[3], Radius
Disk	Disk. Var. linked to the model: color[11], Position[3], Origin[3], Degrees[3], InnerRadius, OuterRadius
File3DSImporter	Imports 3D Studio files. Var. linked to the model: color[11], Position[3], Origin[3], Degrees[3]
Cone	Cone. Var. linked to the model: color[11], Position[3], Origin[3], Degrees[3], Radius, Height
HalfPipe	Longitudinal section of a pipe. The length is in the x direction. The radius is in the y direction. Var. linked to the model: color[11], Position[3], Origin[3], Degrees[3], RadiusMin, RadiusMax, Length
ScalarBar	Scalar bar. Var. linked to the model: none
PlanarGrid	Planar grid de size LengthX*LengthY*LengthZ with nCells. Var. linked to the model: color[nCells], Position[3], Origin[3], Degrees[3], LengthX, LengthY, LengthZ, scalars[nCells], posGrid[3]
Plane	Plane. Var. linked to the model: color[11], Position[3], Origin[3], Degrees[3]
Polygon	Polygon. Var. linked to the model: colors[11], Position[3], Origin[3], Degrees[3]
TextReal	Displays a string + real number. Var. linked to the model: var, colors[11], Position[3], Origin[3], Degrees[3]
TrailNPoints	Draws nPoints trails. Var. linked to the model: x[nPoins], y[nPoints]
Line	Polygonal line or polygon with a number of points equals to nPoints. Var. linked to the model: PointPosition[nPoints], colors[11], Origin[3], Degrees[3], Center[3]
LineP	Polygonal line or polygon

Interactive.src.ViewElements.Drawables.Drawable

Base class of the classes describing drawable elements

Information

Drawable class has to be inherited from the classes describing drawable elements. This class inherits from the IDrawable class.

• Send information to every C++ view. The following information is sent by each drawable element to every view connected to the simulation server:
  • Value of the num variable corresponding to the drawable element.
  • Geometric properties of the drawable element. The value of the numInt parameter sets the number of data to be sent. These data are stored in the vert[:] vector.
  • Color properties of the drawable element. The value of the numIntColor parameter sets the number of data to be sent. These data are stored in the colors[:] vector. This information is sent at each communication interval, when the following two conditions are satisfied: (1) the refreshView variable value has changed; and (2) the windowClosed variable value is false.
• Finish the simulation when the C++ view is closed. A when is triggered when the drawable element sends data to every view and doesn't receive any reception confirmation from any view after waiting T_Max seconds for it.
  This when includes the following code: (1) a call to the Modelica built-in operator terminate(...), which finishes the simulation; (2) a call to the shutDownConnection external function included in the CServer package; and (3) the windowClosed boolean variable is set to true.

Extends from Interfaces.IDrawable (Interfaces of the classes describing drawable elements).

Connectors

Interactive.src.ViewElements.Drawables.Shape

Base class of the classes describing 3-D source drawables

Information

Shape class is inherited from classes describing 3-D source drawables (i.e., Sphere, Cube, Cylinder, etc). This class includes the parameters required to describe the color properties of the drawable element.

This class includes the declaration of the variable color[:]. The value of color[:] is set to the value of the colorp[:] parameter (filling color), diffusep[:], specularp[:] , specularPowerp[:], opacityp[:], edgeVisibility[:], colorlp[:] (line color) if the intColor parameter is 0, or it has to be provided by the virtual-lab developer otherwise.

Parameters

Interactive.src.ViewElements.Drawables.Sphere

Sphere. Var. linked to the model: color[11], Position[3], Origin[3], Degrees[3] and Radius

Information

This class extends the following two classes: Drawable and Shape.
Sphere class draws a sphere.The position of the sphere center (Position[:] variable), the point about which rotation take place (Origin[:] variable), the rotation degrees in axes x, y and z (Degrees[:] variable) and its radius (Radius[:] variable) can be linked to the model variables.

Extends from Drawable (Base class of the classes describing drawable elements), Shape (Base class of the classes describing 3-D source drawables).

Parameters

Connectors

Interactive.src.ViewElements.Drawables.Text

Displays a string. Var. linked to the model: color[11], Position[3], Origin[3], Degrees[3].

Information

This class extends the following two classes: Drawable and Shape.
Text class displays a string. The position of the string center (Position[:] variable), the point about which rotation take place (Origin[:] variable) and the rotation degrees in axes x, y and z (Degrees[:] variable) can be linked to the model variables.

Extends from Drawable (Base class of the classes describing drawable elements), Shape (Base class of the classes describing 3-D source drawables).

Parameters

Connectors

Interactive.src.ViewElements.Drawables.Arrow

Arrow. Var. linked to the model: color[11], Position[3], Origin[3], Degrees[3], scale

Information

This class inherits from the Drawable and the Shape classes.
Arrow class displays a vector. The position of its center (Position[:] variable), the point about which rotation take place (Origin[:] variable), the rotation degrees in axes x, y and z (Degrees[:] variable) and the arrow scale factor (scale[:] variable) can be linked to the model variables.

Extends from Drawable (Base class of the classes describing drawable elements), Shape (Base class of the classes describing 3-D source drawables).

Parameters

Connectors

Interactive.src.ViewElements.Drawables.Trail

Trail. Var. linked to the model: point[2]

Information

This class inherits from the Drawable class.
Creates a drawing element that displays a sequence of points at given coordinates of the hosting container. The point coordinates (point[:] variable) can be linked to the model variables.

Extends from Drawable (Base class of the classes describing drawable elements).

Parameters

Connectors

Interactive.src.ViewElements.Drawables.Cube

Cube. Var. linked to the model: color[11], Position[3], Origin[3], Degrees[3], Length[3]

Information

This class extends the following two classes: Drawable and Shape.
Cube class draws a cube. The position of the cube (Position[:] variable), origin of the cube (Origin[:] variable), rotation angle position of the cube (Degrees[:] variable) and the lengths of the axes (Length[:] variable) can be linked to the model variables.

Extends from Drawable (Base class of the classes describing drawable elements), Shape (Base class of the classes describing 3-D source drawables).

Parameters

Connectors

Interactive.src.ViewElements.Drawables.Cylinder

Cylinder. Var. linked to the model: color[11], Position[3], Origin[3], Degrees[3], Radius, Height

Information

This class extends the following two classes: Drawable and Shape.
Cylinder class draws a cylinder.
The cylinder position (Position[:] variable), origin (Origin[:] variable), rotation angle position (Degrees[:] variable), its height (Height variable) and radius (Radius variable) can be linked to the model variables.

Extends from Drawable (Base class of the classes describing drawable elements), Shape (Base class of the classes describing 3-D source drawables).

Parameters

Connectors

Interactive.src.ViewElements.Drawables.RegularPolygon

Regular polygon inscribed in a circle. Var. linked to the model: color[11], Position[3], Origin[3], Degrees[3], Normal[3], Radius

Information

This class extends the following two classes: Drawable and Shape.

RegularPolygon class draws a polygon inscribed in a circle.
The position of the cube center (Position[:] variable), the point about which rotation take place (Origin[:] variable), the rotation degrees in axes x, y and z (Degrees[:] variable), the normal to the polygon surface (Normal[3] variable) and the radius of the circle inscribing the polygon (Radius variable) can be linked to the model variables.

Extends from Drawable (Base class of the classes describing drawable elements), Shape (Base class of the classes describing 3-D source drawables).

Parameters

Connectors

Interactive.src.ViewElements.Drawables.Disk

Disk. Var. linked to the model: color[11], Position[3], Origin[3], Degrees[3], InnerRadius, OuterRadius

Information

This class extends the following two classes: Drawable and Shape.
Disk class draws a disk. The position of the cube center (Position[:] variable), the point about which rotation take place (Origin[:] variable), the rotation degrees in axes x, y and z (Degrees[:] variable), its inner radius (RadiusMin[:] variable), its outer radius (RadiusMax[:] variable) can be linked to the model variables.

Extends from Drawable (Base class of the classes describing drawable elements), Shape (Base class of the classes describing 3-D source drawables).

Parameters

Connectors

Interactive.src.ViewElements.Drawables.File3DSImporter

Imports 3D Studio files. Var. linked to the model: color[11], Position[3], Origin[3], Degrees[3]

Information

This class extends the following two classes: Drawable and Shape.
File3DSImporter class allow inserting objects in 3D Studio format.
The position of the object center (Position[:] variable), the point about which rotation take place (Origin[:] variable) and the rotation degrees in axes x, y and z (Degrees[:] variable) can be linked to the model variables.

Extends from Drawable (Base class of the classes describing drawable elements), Shape (Base class of the classes describing 3-D source drawables).

Parameters

Connectors

Interactive.src.ViewElements.Drawables.Cone

Cone. Var. linked to the model: color[11], Position[3], Origin[3], Degrees[3], Radius, Height

Information

This class extends the following two classes: Drawable and Shape.
Cone class displays a cone.
The position of its center (Position[:] variable), the point about which rotation take place (Origin[:] variable), the rotation degrees in axes x, y and z (Degrees[:] variable), its radius (Radius[:] variable) and height (Height[:] variable) can be linked to the model variables.

Extends from Drawable (Base class of the classes describing drawable elements), Shape (Base class of the classes describing 3-D source drawables).

Parameters

Connectors

Interactive.src.ViewElements.Drawables.HalfPipe

Longitudinal section of a pipe. The length is in the x direction. The radius is in the y direction. Var. linked to the model: color[11], Position[3], Origin[3], Degrees[3], RadiusMin, RadiusMax, Length

Information

This class extends the following two classes: Drawable and Shape.
HalfPipe class displays the transversal section of a pipe.
The position of its center (Position[:] variable), the point about which rotation take place (Origin[:] variable), the rotation degrees in axes x, y and z (Degrees[:] variable), its inner radius (RadiusMin[:] variable), its outer radius (RadiusMax[:] variable) and length (Length[:] variable) can be linked to the model variables.

Extends from Drawable (Base class of the classes describing drawable elements), Shape (Base class of the classes describing 3-D source drawables).

Parameters

Connectors

Interactive.src.ViewElements.Drawables.ScalarBar

Scalar bar. Var. linked to the model: none

Information

This class extends the following two classes: Drawable and Shape.
ScalarBar class generates a legend showing the correspondence between a colorbar and a range of numeric values. The corresponding numeric values are shown above the colorbar.
The objects of this class can be easily configured: the virtual-lab developer only has to set the data value range, the color range and the type of mapping between the data and the colors (i.e., linear or logarithm ramp).

Extends from Drawable (Base class of the classes describing drawable elements), Shape (Base class of the classes describing 3-D source drawables).

Parameters

Connectors

Interactive.src.ViewElements.Drawables.PlanarGrid

Planar grid de size LengthX*LengthY*LengthZ with nCells. Var. linked to the model: color[nCells], Position[3], Origin[3], Degrees[3], LengthX, LengthY, LengthZ, scalars[nCells], posGrid[3]

Information

This class extends the Drawable class.
Objects of the PlanarGrid class represent 3D regular structures, with variable spacing in the three coordinate directions x-y-z.
The structure in defined by specifying the length and the number of cells in each direction.
Additionally, each cell can contain data attributes (scalars, tensors and vectors) that can be used for visualization. For instance, scalar fields can be represented using colors, vectorial fields using vectors, etc.

Extends from Drawable (Base class of the classes describing drawable elements).

Parameters

Connectors

Interactive.src.ViewElements.Drawables.Plane

Plane. Var. linked to the model: color[11], Position[3], Origin[3], Degrees[3]

Information

This class extends the following two classes: Drawable and Shape.
Plane class draws a plane. The plane is set by specifying 3 points: OriginPoint[3] (i.e., point defining the origin of the plane), Point1[3] (i.e., point defining the first axis of the plane) and Point2[3] (i.e., point defining the second axis of the plane).
The position of its center (Position[:] variable), the point about which rotation take place (Origin[:] variable) and the rotation degrees in axes x, y and z (Degrees[:] variable) can be linked to the model variables.

Extends from Drawable (Base class of the classes describing drawable elements), Shape (Base class of the classes describing 3-D source drawables).

Parameters

Connectors

Interactive.src.ViewElements.Drawables.Polygon

Polygon. Var. linked to the model: colors[11], Position[3], Origin[3], Degrees[3]

Information

This class extends the following two classes: Drawable and Shape.
< Polygon class draws a polygon giving the vertexes coordinates.
The position of the vertexes (PosVertexes[:] variable), the polygon's center (Position[:] variable),the point about which rotation take place (Origin[:] variable),the rotation degrees in axes x, y and z (Degrees[:] variable) and the vertexes coordinates (posVertexes[:] variable) can be linked to the model variables.
The number of the polygon's sides, the color of the polygon's area and line are parameter of this class.

Extends from Drawable (Base class of the classes describing drawable elements), Shape (Base class of the classes describing 3-D source drawables).

Parameters

Connectors

Interactive.src.ViewElements.Drawables.TextReal

Displays a string + real number. Var. linked to the model: var, colors[11], Position[3], Origin[3], Degrees[3]

Information

This class extends the following two classes: Drawable and Shape.
Text class displays a string. The position of the string center (Position[:] variable), the point about which rotation take place (Origin[:] variable) and the rotation degrees in axes x, y and z (Degrees[:] variable) can be linked to the model variables.

Extends from Drawable (Base class of the classes describing drawable elements), Shape (Base class of the classes describing 3-D source drawables).

Parameters

Connectors

Interactive.src.ViewElements.Drawables.TrailNPoints

Draws nPoints trails. Var. linked to the model: x[nPoins], y[nPoints]

Information

This class inherits from the Drawable class.
Creates a drawing element that displays a sequence of points at given coordinates of the hosting container. The point coordinates (point[:] variable) can be linked to the model variables.

Extends from Drawable (Base class of the classes describing drawable elements).

Parameters

Connectors

Interactive.src.ViewElements.Drawables.Line

Polygonal line or polygon with a number of points equals to nPoints. Var. linked to the model: PointPosition[nPoints], colors[11], Origin[3], Degrees[3], Center[3]

Information

This class inherits from the Drawable and Shape class.
Creates a drawing element that displays a sequence of points at given coordinates of the hosting container. The point coordinates (point[:] variable) can be linked to the model variables.

Extends from Drawable (Base class of the classes describing drawable elements), Shape (Base class of the classes describing 3-D source drawables).

Parameters

Connectors

Interactive.src.ViewElements.Drawables.LineP

Polygonal line or polygon

Information

This class inherits from the Drawable and Shape class.
Creates a drawing element that displays a sequence of points at given coordinates of the hosting container. The point coordinates (point[:] variable) can be linked to the model variables.

Extends from Drawable (Base class of the classes describing drawable elements), Shape (Base class of the classes describing 3-D source drawables).

Parameters

Connectors