Interface PrimitiveManagerBoxInterface

The PrimitiveManagerBoxInterface is used to display 3D boxes on top of the DMU, with a rendering hint depending on the relative depth between the 3D boxes and the geometries.

The PrimitiveManagerBoxInterface is accessed through the PrimitiveManagerInterface.getBoxManager function (the PrimitiveManagerInterface is accessed through InfiniteEngineInterface.getPrimitiveManager).

A 3D box is an axis aligned box, consisting of 12 lines, and 6 faces. Rendered 3D boxes are manipulated through their ids (and not a dedicated object), indeed each box is assigned a strictly positive integer id that will represent it. 0 is an invalid box id.

The colors of the 3D boxes are handled by the PrimitiveManagerMaterialInterface, accessed through PrimitiveManagerInterface.getPrimitiveMaterialManager. Materials are accessed by their ids, and modified by their ids. 3D primitives are rendered colored with their primitive material id, and not directly from a color.
WARNING : do not confuse the PrimitiveManagerMaterialInterface and the MaterialManagerInterface, these two interfaces are separated, do not use MaterialManagerInterface ids to draw boxes !!!

Creating a 3D box may be done with the following :

/** 
 * Sample to explain how to create 3d boxes on top of the rendering (PrimitiveManagerBoxInterface).
 */
import { InfiniteEngineInterface, PrimitiveManagerMaterialInterface, PrimitiveManagerBoxInterface, Vector4, Vector3 } from 'generated_files/documentation/appinfiniteapi';

// created previously
let lInfiniteEngine : InfiniteEngineInterface;
// created previously, the box center
let lBoxCenter : Vector3;
// created previously, the box half extent in x,y,z
let lBoxHalfExtent : Vector3;

// the material edges of the box
let lEdgeColorMaterial : number = -1;
// the material for the faces of the box
let lFaceColorMaterial : number = -1;
// the primitive material manager
const lPrimitiveMaterialManager : PrimitiveManagerMaterialInterface = lInfiniteEngine.getPrimitiveManager().getPrimitiveMaterialManager();
// the box manager
const lBoxManager : PrimitiveManagerBoxInterface = lInfiniteEngine.getPrimitiveManager().getBoxManager();

// face color is white opaque (1 as last parameter)
const lFaceColor : Vector4 = new Vector4(1, 1, 1, 1);
// edge color is red semi transparent (0.5 as last parameter)
const lEdgeColor : Vector4 = new Vector4(1, 0, 0, 0.5);

// create materials
lFaceColorMaterial = lPrimitiveMaterialManager.createPrimitiveMaterial(lFaceColor);
lEdgeColorMaterial = lPrimitiveMaterialManager.createPrimitiveMaterial(lEdgeColor);

// and create the box
const lBoxId : number = lBoxManager.createBox(
    // center, half extent
    lBoxCenter,
    lBoxHalfExtent,
    // colors
    lEdgeColorMaterial,
    lFaceColorMaterial,
    // line width
    5
);

console.log('Box id is ' + lBoxId);

Copy

You may create also lines, points, etc with PrimitiveManagerLineInterface, PrimitiveManagerPointInterface, etc.

See

• PrimitiveManagerMaterialInterface
• PrimitiveManagerInterface
• InfiniteEngineInterface