3D Models in a Workspace Connected to Altium Designer

Parent page: Managed Domain Models

Altium Designer, in conjunction with your managed content server, caters for the ability to create and manage 3D Model Items in that server. Used in a similar fashion to file-based linked 3D models,  a managed 3D Model Item can hold a 3D model file, that is then referenced through a 3D body attached to a standard 2D footprint. Once a 3D Model Item has been created (and data uploaded into a revision of it), and its lifecycle state set to a level that the organization views as ready for use at the design level, it can be reused in future board-level design projects.

Folder Type

When creating the folder in which to store a 3D Model Item, you can specify the folder's type. This has no bearing on the content of the folder - uploading will always result in a 3D Model Item. It simply provides a visual 'clue' a s to what is stored in a folder and can be beneficial when browsing a server for particular content. To nominate a folder's use as a container for 3D Model Items, set its Folder Type as 3D Models, when defining the folder properties in the Edit Folder dialog.

Specifying the folder type - its intended use - gives a visual indication of the content of that folder when browsing the server.

Item Type

When creating the target 3D Model Item in which to store your 3D model file, ensure that its Content Type is set to 3D Model, in the Create New Item dialog. If you are creating the Item in a 3D Models type folder, this Item type will be available from the right-click context menu when creating the Item.

Creating a 3D Model Item within a 3D Models folder - the correct Content Type is available on the context menu.

Uploading a 3D Model File

So far, we've discussed the support for a 3D Model Item in the server, in terms of related folder and item types. Uploading a 3D model file into the revision of such an item can be performed in a couple of ways.

Upload Menu

A 3D model file can be uploaded by right-clicking on the required 3D Model Item in the Explorer panel, and choosing the Upload command from the context menu. The Create New Revision dialog will appear, in which you can change Name, Description, and add release notes as required. Use the Sources region of the dialog to load the required model file. This can be performed by dragging and dropping the file from Windows Explorer, onto the region. Alternatively, click the  button - the Add Files dialog (a standard Windows open-type dialog) will appear. Use this to browse to, and open, the required model file.

Supported formats are:

• STEP File (*.step; *.stp)
• Parasolid File (*.x_t; *.x_b)
• SolidWorks Part File (*.sldprt)

Manually specifying the 3D model file to be uploaded to the target 3D Model Item.

Once the desired file is dropped in, or selected and the Open button clicked, an entry for it will appear back in the Sources region. Proceed with the upload by clicking the OK button. The graphical depiction of the uploaded model can be viewed on the Preview aspect view tab for the Item Revision, in the Explorer panel.

Browse the released revision of the 3D Model Item, back in the Explorer panel. Switch to the Preview aspect view tab to see its graphical depiction.

Drag and Drop from Windows Explorer

A 3D model file can also be uploaded by dragging the selected file from a source folder in your Windows Explorer, and dropping onto the required target 3D Model Item in the Explorer panel. The Create New Revision dialog will appear, with the dragged file listed in the Sources region. Add any Release Notes as required, and then click the OK button.

Uploading a 3D model using the drag and drop method.

Reusing a Managed 3D Model Item

Related page: Controlling Access to Server Content

Once a 3D model file has been uploaded to a managed content server, and its lifecycle state set to a level that the organization views as ready for use at the design level, that 3D model can be reused in future board-level design projects.

A 3D body is used to provide the three-dimensional representation of the component in the PCB domain, and is typically placed and defined in conjunction with the standard 2D footprint model, when defining that footprint model (which is then released to the managed content server as a revision of a target Footprint Item).

The quickest, and easiest way to use a revision of a 3D Model Item, is to place it directly from the server into a PCB or PCB Library document, creating a 3D Body object that references that Item Revision. The 3D Body object can then be fine-tuned as required. To place:

• Ensure a PCB Library (or PCB) document is open as the active design document.
• Drag and drop the required revision of the 3D Model Item (from the Explorer panel) into the PCB workspace. Alternatively, right-click on the required revision of the 3D Model Item and choose the Place command from the context menu.

Conversely, if you are defining the 3D Body object, and want to reference a 3D model that is stored in a managed content server, this can be done from within the Properties panel, when defining the properties for the body.

To do so:

1. In the 3D Model Type region of the panel, choose the Generic option.
2. In the Source region of the panel, choose the Server option.
3. Click the  button to the right of the Item Revision field. This gives access to the Choose Item dialog (essentially an incarnation of the Explorer panel). Use this dialog to browse to, and select, the revision of the required 3D Model Item. After clicking OK, a link will be created between the 3D Body and the target revision of the 3D Model Item. Evidence of this link can be seen back in the Properties panel. Note that the Identifier field for the 3D Body will be filled with the Item-Revision ID of the linked 3D Model Item.

Manually linking a 3D Body object to a revision of a 3D Model Item, in the target server.

The 3D Model Item being used can be changed at any time - click  and select a revision of a different 3D Model Item.

The status of the linked 3D Model Item is reflected on the Properties panel. If a newer revision of the linked Item is available, click the  button, to use that latest revision.

Releasing a PCB 2D/3D Component Model into the Server

When directly editing the source 2D footprint model stored within a revision of a Footprint Item - within a temporary PCB Library Editor - you can define a 3D Body object for it, with that body referencing (linked to) a revision of a 3D Model Item in a managed content server. The following happens upon release of that footprint model:

• The 3D Model link is detected and the revision of the 3D Model Item will appear listed as a child Item of the Footprint Item, in its Children aspect view.

• The revision of the 3D Model Item is detected as 'being used' and will therefore list the parent Footprint Item in its Where-used aspect view.

Updating a 3D Model Item

If you need to change the 3D model stored in a 3D Model Item, upload the required new model to that Item - the new model will be stored in the next revision of that Item.

Updating Related Footprint Item Revisions

When you make a change to a 3D model, the moment you upload that change into a new revision of the 3D Model Item, any Footprint Items that use that model will become effectively out of date, still using the previous revision. In most cases, you will no doubt want to re-release those footprints, with the respective model links updated to use the latest revision available. To streamline this process your managed content server, in conjunction with Altium Designer, facilitates the ability to update related Footprint Items - at the point of uploading to the latest revision of the 3D Model Item.

Once uploaded, if any Footprint Items currently reference the Item, a dialog will appear asking whether or not you wish to update those items.

A PCB Library document is then opened in its associated temporary editor (for direct editing). When multiple Footprint Items use the 3D Model Item, rather than separate instances of PCB Libraries being opened, a single PcbLib document is presented, containing all affected PCB 2D/3D component models.

Once the 3D body for a model is updated to reference the latest revision of the 3D Model Item (where needed), click the  button (on the Quick Access Bar, or from the PCB Lib Standard toolbar), to release the modified model(s) into new revision(s) of the corresponding Footprint Item(s), back in the target server:

• If only a single Footprint Item revision is affected, the Edit Revision dialog will appear. Change Name, Description, and add release notes as required. After clicking OK, the release will proceed, and the temporary PCB Library editor then closed.
• If multiple Footprint Item revisions are affected, the Release Manager dialog will appear. This lists all Footprint Item revisions that are scheduled to be released - by default all enabled for inclusion in the release. Make any changes - to Name, Description, and inclusion (Enable option) - as required, then click the Release Items button. View the impending release changes in the subsequent Confirm Release dialog, then click OK. Once the release process completes - indicated by Release Succeeded in the applicable Action-Status field(s) - close the dialog. The temporary PCB Library editor will also then be closed.

Downloading a 3D Model File

Download the 3D model file stored in a revision of a 3D Model Item, by right-clicking on that revision (in the Explorer panel) and choosing the Operations » Download command from the context menu. The file will be downloaded into a sub-folder under the chosen directory, named using the Item Revision ID. The file can be found in the Released folder therein.

3D Model Extraction

Where 3D models (e.g. STEP) have been embedded into the 2D footprint models within a PCB Library document (*.PcbLib), the PCB Library Editor provides a utility with which to extract those models. To do so:

1. Open the PCB Library you want to extract 3D models from.
2. Choose the Tools » Extract 3D Models command from the main menus.
3. In the Generate 3D Model Files from PCB Libraries dialog that appears, specify where the generated files are to be stored - either in a sub-folder of the location in which the source PCB Library resides, or in a specified folder elsewhere. If the nominated folder exists, it will be used. If not, it will be created.
4. Optionally choose to Overwrite existing files - have existing 3D model files with the same name overwritten when new files are generated.
5. After defining options as required, click OK. Generation will proceed and a confirmation dialog will appear when the process is complete, stating how many 3D model files were generated.

Example 3D model files generated from a PCB Library by using the extraction tool.