Box

Model ElementThe Box element allows you to generate a rectangular Box graphic. It can be defined from the center or from the corner.

Class Name

Box

Attribute Summary

Name Property Modifiable by command? Designable?
corner Reference (Marker) No Yes
cm Reference (Marker) Yes
x Double () Yes
y Double () Yes
z Double () Yes
refinement_level Int ()  
material_inside Bool ()  
color String()  
hidden Bool() No

Usage

Box(cm=Marker(), x=100, y=200, z=200)
Box (cormer=Marker(), x=10, y=200, z=150)

Attributes

corner
Reference(Marker)
The marker that defines the corner of the Box. This attribute is mutually exclusive with the cm marker.
cm
Reference(Marker)
The marker that defines the center of the Box. This attribute is mutually exclusive with the corner marker.
x
Double()
The x coordinate of the Box.
y
Double()
The y coordinate of the Box.
z
Double()
The z coordinate of the Box.
refinement_level
Double()
Defines level of detail of the Box geometry.
material_inside
Bool ()
Specifies if the graphic has material inside or outside. material_inside is a boolean flag (True/False).
True means the geometry is solid. In other words, it is filled with material and its exterior is devoid of material. Consequently, the surface normals of the geometry point outward.
False means the converse: The exterior of the geometry is filled with material and the interior is devoid of material. In this case, the surface normals of the geometry point inward.
color
String()
The color of the graphic for H3D animation. Specified as RGB (Red : Green : Blue).
hidden
Boolean
Specifies weather the graphics is being written to the H3D file or not.
  • True implies that the graphic is hidden and is not written to the H3D file.
  • False implies that the graphic is not hidden and is written to the H3D file.
This attribute is optional. When not specified, it defaults to False.

Example

Define Box geometry via center marker:
Box (center=marker1,x=100, y=100, z=100)

Comments

  1. See Properties for an explanation about what properties are, why they are used, and how you can extend these.