Crystal InterVision Library Editor. Quick Start Guide. Version June Copyright 2006 Crystal InterActive Technologies

Transcription

1 Crystal InterVision Library Editor Quick Start Guide Version June 2006 Copyright 2006 Crystal InterActive Technologies

2 Content 0 Overview InterVision 3D Geometry Files InterVision 3D Library Objects Website and 3D Window functions System Requirements Tutorial 1 Create a base object Step 1 Create or import 3D geometry in 3D Studio Max Step 2 - Export the 3D geometry to InterVision geometry file in correct location Step 3 Import geometry into Library Editor and save InterVision library object Step 4 Organizing the object into categories via the Crystal InterVision Manager website Tutorial 2 Create a composite object Step 0 Create three base library objects Step 1 - Create a new composite object Step 2 Add objects to composite object Tutorial 3 Create a component Step 1 Create or import 3D geometry in 3D Studio Max Step 2 - Export the 3D geometry to InterVision geometry file in correct location Step 3 Import geometry into Library Editor and assign basic properties Step 4 Create the first POC Step 5 Create the second POC Tutorial 4 Create a composite object using components with connections Step 1 Make a new component Step 2 Create a new composite object Step 3 Insert components into composite object Step 4 Assign utility to composite object Tutorial 5 Create POCs in Library Editor with 3D POC objects Step 1 - Create a new base library object Step 2 - Add a new POC Tutorial 6 Create clearances, EB-point and OHV-points Step 1 - Create a new base library object Step 2 - Create OHV-point Step 3 - Create EB-point Step 4 Create clearance Tutorial 7 Create 2D AutoCAD blocks of 3D library objects Step 1 Save 2D sections in Library Editor Step 2 Convert 2D sections to AutoCAD blocks

3 0 Overview This tutorial describes how to create and publish 3D library objects for Crystal InterVision Design version 2.3. The following subjects will be discussed: creating InterVision 3D geometry files importing geometry files and creating intelligent InterVision 3D library objects publishing and organizing library objects on Crystal InterVision Server 0.1 InterVision 3D Geometry Files 3D geometry files for the Library Editor can be created in two ways: create or import geometry in 3D Studio Max and export using the InterVision Export plugin for 3D Studio Max create geometry in Component Editor Both ways result in a InterVision 3D Geometry file with file extension *.tre. This file can be imported into the Library Editor. Note : this tutorial does not address functions in 3D Studio Max to create or modify geometry. For specific 3D Studio Max functions, please refer to the 3D Studio Max manual. 0.2 InterVision 3D Library Objects An InterVision 3D Library object is a 3D object with special properties. The special properties are assigned to the 3D object in the Library Editor. The following properties can be assigned: Required properties object name object type (for example component, process tool, building support ) pivot (equivalent for AutoCAD s insertion point ) Optional properties blockings and clearances (to be used by collision checker) POC properties (diameter, material, utility, etc) equipment boundary (EB) point and overhead vehicle (OHV) point How to assign these properties will be discussed in this this tutorial. 2

4 Base and Composite library objects InterVision uses two classes of library objects, being: base objects composite objects Base objects are objects of the lowest level. Base objects are geometry files with InterVision properties. Composite objects are groups of base objects. Composite objects their own specific properties and have one or more references to other library objects. In AutoCAD terminology, a composite object can be looked at as a drawing with Xrefs to other drawings. These Xrefs can be either base objects or composite objects ( nested Xrefs ). Certain properties can only be assigned to base objects (like POCs) while other properties only can be assigned to composite objects (like connections). 0.3 Website and 3D Window functions The Library Editor website has a 3D window, a feedback line showing information and instructions, and a Snapshot-button to save the corrent 3D window to a JPEG-file. The 3D window contains navigation buttons, an XYZ-axis for orientation and in the center a pivot-object indicating the origin (0,0,0) of the 3D environment. 0.4 System Requirements The following applications must be installed to use the tutorial: 3D Studio Max version 5,6,7 or 8 Crystal InterVision export plugin for 3D Studio Max Crystal InterVision Design website Crystal InterVision Library Editor website Crystal InterVision Database and Manager website 3

5 1 Tutorial 1 Create a base object In this tutorial a new base object will be made via 3D Studio Max. We will assign some basic properties, being the name ( display name ) of the object and object type. 1.1 Step 1 Create or import 3D geometry in 3D Studio Max Here we will use a 3D model of a workstation. The 3D model can either be made directly inside 3D Studio Max, or imported via the File Import options of 3D Studio Max. In 3D Studio Max, the model looks like this: It is important to check and modify the location of the pivot of the model, being point 0,0,0. In this case it is logical to locate it at the bottom of the column. The pivot will be the insertion point of the library object. It also will be the rotation point of the object when rotating the object in InterVision. 4

6 1.2 Step 2 - Export the 3D geometry to InterVision geometry file in correct location Choose menu File Export Select the folder Models of your current library: select citk Stream Export in Save as type and specify the name of the library object, for example Workstation.tre : specify Publish and FROM MAX : 5

7 Note: in case the 3D model of the workstation is made for example in inches (1 unit in 3D Studio is 1 inch), then option Unit override must be set to millimeters! In case option FROM MAX is used, then the 3D model will be 25.4 times too large. Now you have a new file in folder Models called workstation.tre. This file will be imported into the library editor. Textures In case the 3D model uses bitmap textures, these bitmap files must be placed in folder Textures of the same current library. The textures must have format *.tga or *.png. 1.3 Step 3 Import geometry into Library Editor and save InterVision library object Do the following steps to import and save the library object Start the Library Editor website and logon Double-click and choose menu function File - New Base Library object Select the geometry file Workstation.tre from the folder Models. The geometry file will be loaded. Next we will specify some basic properties. Double-click on the background and choose menu Edit Properties Specify the Display Name and Object Type: 6

8 Notes: - The Display Name can be identical to Name, but can also be any other name. Property Name is the name of the 3D geometry. - Object Type is used to determine how to export the object to CAD drawing in InterVision Design. Here we can choose object type General. After having specified the Display Name and Object Type, the object can be saved to library. Double-click and choose menu File Save Library Object' Choose Yes when asked Save catalog image now? in case your current 3D view is correct for making a screenshot of the object. If you choose No, you always can save a catalog image later via menu File Save Catalog image Save 2D section files to create 2D AutoCAD blocks (optional, see tutorial 8) Tip: to hide the navigation buttons shown in the bottom of the screen, press key w 1.4 Step 4 Organizing the object into categories via the Crystal InterVision Manager website By default, new library objects are saved to database category Unsorted. You can verify this by loading the new library object into the Library Editor via menu File Load Library Object from catalog and choose category Unsorted. There you will find the new library object. 7

9 To put the object into one or more other categories, do the following steps: Start Manager website and login Click on menu Objects : Search for the new library object via the Search function Click on Edit -icon of the found object to open its Edit-page Assign the object to a category by checking the categories shown on the right Uncheck the category Unsorted to remove the object from this category Press Submit to save the changes Now you could check the new object and category by starting the Library Editor and by choosing menu File Load Library Object from catalog. 8

10 2 Tutorial 2 Create a composite object In this tutorial we will make the same object as in tutorial 1, but now the object will be constructed as a composite object. Instead of one 3D Studio Max model, we have now three separate 3D Studio Max models: Workstation_Column.tre Workstation_Shelf.tre Workstation_FlatPanel.tre To split an object into separate object is especially useful when a part of the total model is used by different library objects, and/or is used multiple times in one object. Another advantage is that the parts can be collected in a part list (BOM). The workstation of tutorial 1 can only be listed as one object Workstation in the part list, where the workstation in this tutorial will be listed using its parts. 2.1 Step 0 Create three base library objects Before we start creating the composite object, first create three base library objects using these three model, as follows: Export each 3D Studio Max model to InterVision 3D Geometry file like in step 1 and 2 from tutorial 1 Specify the name and object type of each model and save it, like in step 3 of tutorial 1 Organize the new objects into categories, like in step 4 of tutorial 1 Now that we have the three base objects, we can start creating a composite object using these objects. 2.2 Step 1 - Create a new composite object Start the Library Editor website and logon Double-click and choose menu function File - New Composite Library object Specify the Name, Display Name and object type, like you did in step 3 of tutorial 1 9

11 After you have specified these properties, and the window is closed, you will find no 3D object. You have just created an empty group. Double-click to see the current object name and type in first line of context menu. 2.3 Step 2 Add objects to composite object Double-click and choose menu Insert Library Object from catalog Choose one of the three objects Repeat the same for the other two objects Now you have a new composite object with three base objects. The only thing left before saving the object is to locate the three objects at the correct position: Double-click on the column and choose menu Edit - Move and Rotate Manual Use keys a, z, s, d and Enter to move the column. Use shift+ a and shift+ z to move the object vertically. You also can specify the position via XYZ-coordinates and via relative positioning. Repeat the same for the other two objects 10

12 Save the object like in step 3 of tutorial 1 Organize the new composite object into categories, like in step 4 of tutorial 1 Save 2D section files to create 2D AutoCAD blocks (optional, see tutorial 8) 11

13 3 Tutorial 3 Create a component In this tutorial we will make a component which will have a valve body and two POCs, shown here as exploded view : 3.1 Step 1 Create or import 3D geometry in 3D Studio Max Follow the same steps as step 1 in tutorial 1. Check and modify the locations of the pivots. Geometry considerations In bottom right corner of the above image, the three parts of this 3D object are shown. It is a requirement that the POC object is a separate object in the geometry. In this example also a hierarchy in 3D Studio Max is shown: the POC objects are made children of the valve body object via the Max-function link. This is not required, however. Also important is the pivot of the POC objects: these must be located in the center. This will determine the location of the POC and this the location of the centerline of the connected pipe (see step 4 and 5). In the next image you can see that not only the two pivots of the POCs are exactly in one line, but also the pivot of the valve body and the pivot of the entire object (main pivot = 0,0,0). This is the ideal situation. 12

14 Four aligned POCs = 2x POC pivot, 1x valve body pivot, 1x main pivot (=0,0,0) You are free to choose how the POC geometry object looks like. The only condition is that the POC is a separate object. In the next image, an alternative but also correct subdivision of the POCs and valve body is shown: 3.2 Step 2 - Export the 3D geometry to InterVision geometry file in correct location Follow the same step as step 2 in tutorial 1. This step will result in file DV-GF-0001.tre. 3.3 Step 3 Import geometry into Library Editor and assign basic properties In this step, we will add POC properties and blockings for use by the collision checker. Do the following steps: Start the Library Editor website and logon Double-click and choose menu function File - New Base Library object Select the geometry file DV-GF-0001.tre from the folder Models. 13

15 The geometry file will be loaded. Next we will specify some basic properties. Double-click on the background and choose menu Edit Properties Specify the Display Name and Object Type. Here we have to specify the object type as Component. The Display Name can remain identical to the model name ( Name ): Now save the object via menu File Save Library Object Tip: you can hide the red/green/blue pivot object via menu Hide Pivot 3.4 Step 4 Create the first POC Click on the POC object and choose Create POC In pop-up window, specify the POC properties: 14

16 Notes: - Property Display Name is optional. If empty, the name of the 3D POC-object will be used - Property Utility can be set as neutral in case this POC can have more than one utility. For components like this valve this is mostly true. For dedicated POCs on process equipment this is mostly not true. - Property Material also can be neutral but here we specify it. - Property Connection start/end is either start or end. For components with two POCs, like this valves, one POC must be start and one POC must be end! Two start POCs or two end POCs on a component with two POCs is mostly invalid! - Property Direction specifies the direction of the connection. - All other properties can remain empty or unchanged Flow directions vs start- and end-pocs For hook-up components, the choice whether a POC is a start- or end-poc is determined by the way the component is used in a connection. Normally, start-pocs are used to create a connection from a process tool towards the take-off or remote tool, and end-pocs are used as end-point of connections coming from a the process tool, as shown in next illustration. Flow directions are shown via an arrow sign in the POC-line. The flow direction depends on the Flow setting of the utility in the database. For component used in facility connections, the flow direction is used to determine whether a POC is a start-poc ( flow out ) or end-poc ( flow in ): 15

17 3.5 Step 5 Create the second POC Repeat like in previous step for the second POC, but now specify end in line Connection start/end in case the previous POC was start. Step 6 Create a link between the POCs Because InterVision must know that the utility flow from POC #1 continues to POC #2, we have to make a link between the POCs. Do the following: Click on a POC and choose menu Edit Link to POC Click on the other POC. The feedback line will show that a link has been made Step 7 Create blockings To avoid a connection going through the component, we can add blockings to the component. Note that blockings can be added to any type of object, and are always optional! Turn on blockings via key b, or via menu View Show Blockings. You will see two red volumes near the POCs. These POC blockings are made automatically by InterVision to avoid pipes passing by too close the POCs. Click on valve body and choose menu Create Blocking. Now a new red volume appears. The size is determined by the geometry of the valve body. You can change the size and location of the blocking by clicking on it and using the Edit functions. When ready, save the component Save 2D section files to create 2D AutoCAD blocks (optional, see tutorial 8) 16

18 4 Tutorial 4 Create a composite object using components with connections In this tutorial a composite object will be made using base components and connections. We will create a gasstick like in next image, but remember that connections can be made between POCs of any type of objects, not only components. 4.1 Step 1 Make a new component Repeat the steps from tutorial 3 for another component. Here we will use this component. Here the POCs have the same properties as component from tutorial Step 2 Create a new composite object Double-click and choose menu function File - New Composite Library object Specify the Name, Display Name and object type. Here the object type must be typical! 17

19 4.3 Step 3 Insert components into composite object Insert the component made in tutorial 3 via menu Insert Library Object from catalog Add the new component to this composite by clicking on the component from previous step and choose menu Insert Library Object from catalog : Note: by clicking on the 1 st component, the new component will be inserted using the same position and rotation as the 1 st component. In case the Insert from catatlog use initiated by clicking on the background, the position and rotation of the new component will be 0,0,0. Move the new component to the correct location via menu Edit Move and Rotate : Tip: you can activate Top View via key t to position the object in a 2D view Insert a 3 rd component in the same manner: 18

20 4.4 Step 4 Assign utility to composite object In case this gasstick can only be used by one type of utility, assign the utility to this gasstick now via menu Edit Properties and select a utility in the pop-up window: Start a connection by clicking on a start-poc and choose menu Edit- Start Connection Add a T-Piece to the end of the connection by clicking on the pipe and choose menu Insert T-Piece : Tip: use key Tab to reverse the start-poc and end-poc when the T-Piece is flashing. Create another connection between the start-poc of the component and end-poc of the T-Piece Create a last connection between the start-poc of the T-Piece and the end-poc of the component: 19

21 Now the gasstick is ready to be saved. In case you wish to extend the ends of the gasstick more, do the following: Create a connection on the start-poc of the component: Click on end of connection and choose Insert Pipe End Connector : A small component will be added to the free end of the connection: 20

22 Note: connections which are not one both end attached to POCs cannot be saved in the library object! For this reason the pipe end connector is used. This component will not be listed in any part list, unlike all other components, T-pieces, etc, used in library objects. Add a pipe end connector also on the end-poc of the other components by clicking on the end-poc (!) : Move the pipe end connector to the right location via menu Edit - Move and Rotate Save and organize the component in Manager website Save 2D section files to create 2D AutoCAD blocks (optional, see tutorial 8) 21

23 5 Tutorial 5 Create POCs in Library Editor with 3D POC objects In tutorial 3 a POC is created using a 3D POC object made in 3D Studio Max. This tutorial shows how to make a POC in case the 3D library object does not have a 3D POC object. Note: this feature is only available for hook-up library objects. 5.1 Step 1 - Create a new base library object Load the geometry file: Assign the Diplay name and object type: 5.2 Step 2 - Add a new POC Go to the location where a new POC must be added: 22

24 Click approximately where the new POC must be located and choose menu Create POC on Pickpoint : Specify the properties of the new POC: 23

25 Notes: - Property Cylinder length is used to draw a 3D cylinder object at the POC location. The end of this cylinder is the actual POC location. - Specify a Display Name for this POC. This property is required (unlike POC created using 3D POC objects). - Specify all other properties. See also step 4 of tutorial 3. Click accept and a new POC is created: Move the POC to the exact location by clicking on the POC and choose menu Edit Move : Save and organize this object Save 2D section files to create 2D AutoCAD blocks (optional, see tutorial 8) 24

26 6 Tutorial 6 Create clearances, EB-point and OHV-points InterVision supports several specific optional properties used for process equipment layouts, being: clearances EB-points ( equipment boundary points ) OHV-points ( overhead vehicle points ) These special optional properties will be shown in 2D CAD layout drawings generated from the InterVision 3D design file. Note: these feature is only available for hook-up library objects of type Process Tool and Remote Tool. 6.1 Step 1 - Create a new base library object Load the geometry file: Assign the Diplay name and object type: 25

27 6.2 Step 2 - Create OHV-point Click on the object where the OHV-point is located, and choose menu Create OHV-point. An OHV-point is added at the pivot of the selected object. The OHV-point is indicated as a vertical line ( laser ). The position of the OHV-point can be modified manually by clicking on the OHV-object located at the bottom-end of the vertical line. 6.3 Step 3 - Create EB-point Click on the location where the EB-point must be located, and choose menu Create EB-point. The EB-point can be moved manually by clicking on the EB-object located at the bottom-end of the vertical line. 6.4 Step 4 Create clearance Click on object to create an initial clearance volume and choose Create - Clearance. A light blue volume is created around the selected object: 26

28 Modify the size and location of the clearance by clicking on it and choose menu Edit, similar to blockings in step 7 of tutorial 3: Add blockings like in step 7 of tutorial 3 to finalize this object: Save and organize this object Save 2D section files to create 2D AutoCAD blocks (optional, see tutorial 8) 27

29 7 Tutorial 7 Create 2D AutoCAD blocks of 3D library objects In case an AutoCAD drawing is generated from the 3D InterVision Design, 2D AutoCAD blocks ( footprints, elevations, etc) must exist in order to produce a useful result. This tutorial shows how to make 2D AutoCAD blocks from 3D InterVision library objects in the Library Editor. 7.1 Step 1 Save 2D sections in Library Editor Load a library object Click anywhere in the 3D window and choose menu File Save 2D Sections Now several 2D sections are generated and stored in files with extension *.xsect in folder Output of the Library Editor folder: These 2D sections contain top views (footprints) and side views (elevations) of the object 28

30 7.2 Step 2 Convert 2D sections to AutoCAD blocks Note: you must have the Crystal InterVision AutoCAD plugin installed on your computer to do the next steps. Start AutoCAD and activate the Crystal plugin Choose menu Crystal InterVision Import XSECT Cross Section : Select one *.xsect file in folder Output of the Library Editor and press OK In next window, specify what you want to do: Select scale to INCH in case the AutoCAD block must be saved inches, choose keep MM to save in millimeters Choose All files in this folder to convert all files automatically 29

31 Press OK. Now the 2D section file(s) will be converted to AutoCAD drawings. After this, the *.xsect files can be deleted. The resulting AutoCAD drawings can be modified by hand to improve the quality. Notes: - The origin (0,0,0) and rotation of the 2D drawing must NEVER be changed to avoid conflicts between the 3D InterVision object and the 2D block. - In case you want to use a footprint drawing made by hand or obtained from a 3 rd party, then the filename, scale, origin and rotation of this drawing must match the drawings generated by InterVision to avoid conflicts between the 3D InterVision object and the 2D block. Top views InterVision generates two kinds of top views. One top view shows the object as seen from above, and is called <object name>.dwg : This view also shows clearances in case they have been defined in the library object: The second top view shows the outline of the object, and is called <object name>_outline.dwg. This outline drawing is generated for process tools, remote tools, facility tools, tool racks, racks, general objects and valve boxes. 30