Altium Designer Documentation

Compile Mask

Modified by Susan Riege on Jul 20, 2020
This documentation page references Altium Vault, which is no longer a supported product. Altium Vault and its component management features have migrated to Altium Concord Pro.
All Contents

Parent page: Schematic Objects

A placed Compile Mask, hover to collapse.

Summary

A compile mask is a design directive. It is used to effectively hide the area of the design it contains from the Compiler, allowing you to manually prevent error checking for circuitry that may not yet be complete and you know will generated compile errors. This can prove very useful if you need to compile the active document or project to check the integrity of the design in other specific areas, but do not want the clutter of compiler-generated messages associated with unfinished portions of the design.

Availability

Compile masks are available for placement in the Schematic Editor only, by choosing the Place » Directives » Compile Mask command, from the main menus.

Placement

After launching the command, the cursor will change to a cross-hair and you will enter compile mask placement mode. Placement is made by performing the following sequence of actions:

  1. Position the cursor and click or press Enter to anchor the first corner of the mask.
  2. Move the cursor to adjust the size of the mask, such that it completely encapsulates the area of the design that you want hidden from the Compiler, then click or press Enter to anchor the diagonally-opposite corner and thereby complete placement of the mask. Design objects falling completely within the bounds of the mask will become grayed-out.
  3. Continue placing further compile masks, or right-click or press Esc to exit placement mode.
Press the Tab key during placement to access an associated properties dialog, from where properties for the compile mask can be changed on-the-fly.

While attributes can be modified during placement (Tab to bring up associated properties dialog), bear in mind that these will become the default settings for further placement unless the Permanent option on the Schematic – Default Primitives page of the Preferences dialog is enabled. When this option is enabled, changes made will affect only the object being placed and subsequent objects placed during the same placement session.

Graphical Editing

This method of editing allows you to select a placed compile mask object directly in the workspace and change its size, shape or location, graphically.

A compile mask can be displayed in either expanded (full frame) or collapsed (small triangle) modes. These modes correspond to the mask being enabled and disabled respectively. Toggle the display mode by clicking on the top-left corner of a placed compile mask.

Click the triangle in the top-left corner to collapse (and disable) a compile mask.

When a fully expanded compile mask object is selected, the following editing handles are available:

A selected Compile Mask (fully expanded).

  • Click and drag A to resize the compile mask in the vertical and horizontal directions simultaneously.
  • Click and drag B to resize the compile mask in the vertical and horizontal directions separately.
  • Click anywhere on the compile mask – away from editing handles – and drag to reposition it. While dragging, the compile mask can be rotated (Spacebar/Shift+Spacebar) or mirrored (X or Y keys to mirror along the X-axis or Y-axis respectively).

The size and shape of a compile mask cannot be changed graphically when it is in collapsed mode, only its location/orientation. As such, editing handles are not available when a collapsed compile mask object is selected:

A selected Compile Mask (collapsed).

  • Click anywhere inside the dashed box and drag to reposition the compile mask as required. The compile mask can be rotated or mirrored while dragging.

If attempting to graphically modify an object that has its Locked property enabled, a dialog will appear asking for confirmation to proceed with the edit. If the Protect Locked Objects option is enabled on the Schematic – Graphical Editing page of the Preferences dialog, and the Locked option for that design object is enabled as well, then that object cannot be selected or graphically edited. Double click on the locked object directly and disable the Locked property or disable the Protect Locked Objects option, to graphically edit the object.

Non-Graphical Editing

The following methods of non-graphical editing are available:

Via an Associated Properties Dialog

Dialog page: Compile Mask

This method of editing uses the following dialog to modify the properties of a compile mask object.

The Compile Mask dialog.

The Compile Mask dialog can be accessed prior to entering placement mode, from the Schematic – Default Primitives page of the Preferences dialog. This allows the default properties for the compile mask object to be changed, which will be applied when placing subsequent compile masks.

During placement, the dialog can be accessed by pressing the Tab key.

After placement, the dialog can be accessed in one of the following ways:

  • Double-clicking on the placed compile mask object.
  • Placing the cursor over the compile mask object, right-clicking and choosing Properties from the context menu.
  • Using the Edit » Change command and clicking once over the placed compile mask object.

Via the SCH Inspector Panel

Panel pages: SCH Inspector, SCH Filter

The SCH Inspector panel enables the designer to interrogate and edit the properties of one or more design objects in the active document. Used in conjunction with appropriate filtering - by using the SCH Filter panel, or the Find Similar Objects dialog - the panel can be used to make changes to multiple objects of the same kind, from one convenient location.

Via the SCH List Panel

Panel pages: SCH List, SCH Filter

The SCH List panel allows the designer to display design objects from one or more documents in tabular format, enabling quick inspection and modification of object attributes. Used in conjunction with appropriate filtering - by using the SCH Filter panel, or the Find Similar Objects dialog - it enables the display of just those objects falling under the scope of the active filter – allowing the designer to target and edit multiple design objects with greater accuracy and efficiency.

Tips

  1. While compile masks can be rotated or mirrored along the X or Y axis, this has no effect on the orientation of the design circuitry within.

 

Found an issue with this document? Highlight the area, then use Ctrl+Enter to report it.

Contact Us

Contact our corporate or local offices directly.

You are reporting an issue with the following selected text
and/or image within the active document:
ALTIUM DESIGNER FREE TRIAL
Altium Designer Free Trial
Let’s get started. First off, are you or your organization already using Altium Designer?

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

In that case, why do you need an evaluation license?

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

Got it. You actually don’t need an evaluation license for that.

Click the button below to download the latest Altium Designer installer.

Download Altium Designer Installer

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

Please fill out the form below to get a quote for a new seat of Altium Designer.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

If you are on Altium Subscription, you don’t need an evaluation license.

If you are not an active Altium Subscription member, please fill out the form below to get your free trial.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Why are you looking to evaluate Altium Designer?

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

You came to the right place! Please fill out the form below to get your free trial started.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Great News!

Valid students can get their very own 6-month Altium Designer Student License for FREE! Just fill out the form below to request your Student License today.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Got it. You can download a free Altium Designer Viewer license which is valid for a 6 months.

Please fill out the form below to request one.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

That’s great! Making things is awesome. We have the perfect program for you.

Upverter is a free community-driven platform designed specifically to meet the needs of makers like you.

Click here to give it a try!

If would like to speak with a representative, please contact your local Altium office.
Copyright © 2019 Altium Limited

Got it. You can download a free Altium Designer Viewer license which is valid for a 6 months.

Please fill out the form below to request one.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.