Home Search

DriveWorks Pro 22
Set Document Entity Suppression State

Send Feedback

Set Document Entity Suppression State

The Set Document Entity Suppression State task will change the suppression state of an Entity on a Node in a DriveWorks 3D Document.

The Set Document Entity Suppression State task works on the following Node Entities:

From a Specification Macro this task can suppress and unsuppress all of these Entities on a Node.

The Set Document Entity Suppression State task works on a 3D Document within a 3D Preview Control. In order to save changes made by this task you will need to use the Save 3D Document task.

It is advised that you use the Save 3D Document task at the end of a Specification for performance.

The Set Document Node Static Transform task does NOT work on 3D Previews created from SOLIDWORKS and DriveWorks Autopilot, or static DriveWorks 3D Files.

Other Entities

This task does not work on Replace Model and Remap Appearance Entities. These are usually used in DriveWorks 3D Documents and can have rules applied to disable them.

When you export a 3D Document as a DriveWorks 3D File, these two entities will be merged into the resultant 3D file. If you replace this new 3D file into a 3D Document these entities will not be used, therefore you don't need to suppress them.


Property NameDescription
Preview Control NameThe name of a 3D Preview Control to perform the action on.
This 3D Preview Control must be using a DriveWorks 3D Document.
Target Node AddressThe address of the Node that you want to suppress entities on.
Entity TypesA pipe delimited list of Entity Types in the format "Model|SpotLight|Etc"
Suppression ValueTRUE to suppress the Entity, FALSE to unsuppress the Entity.
Apply To Child NodesTRUE to apply the suppression state to the Nodes child nodes, FALSE to apply the suppression state to this Node only.


When this task is added the properties are static by default.
See How To: Change A Static Property To A Dynamic Property to enable rules to be built on these properties.

Property NameExample ruleExample resultMeaning
Preview Control Name"3DPreviewControl"3DPreviewControlThis task will run on the named Preview Control. If that Preview Control has a DriveWorks 3D Document, then the task will attempt to set the suppression state of the specified Node.
Target Node Address"Root\Table\Leg-" & DWConstantSelectedLegRoot\Table\Leg-1This is the address of the Node to set the suppression states on.
Entity Types="Rotate|Pan|Camera"1000|0|500This will suppress all Rotate, Pan and Camera Entities in the Node specified along with every child Node Entity.
Suppression Value=TRUETrueTRUE will suppress the entities of the types specified.
Apply To Child Nodes=TRUETrueTRUE will apply the same suppression state to each child Node. This allows you to suppress multiple entities at once.

Entity Types

Entity Types can accept a pipe bar list of Entity names and it can also accept an asterisk (*) to suppress or unsuppress all entities.

These are the Entity names as they should be written in the rule:

Entity NameValue to use in a Rule.
Directional LightDirectionalLight
Spot LightSpotLight
Point LightPointLight

When using an asterisk you may find models disappear. This is expected behavior because it will suppress every Entity type, including Model.

Suppressing the Model entity will suppress the geometry on that Node.

Node Address

All Node Addresses start from the "Root" Node in the DriveWorks 3D Document. This "Root" Node can be renamed, so you may need to enter the renamed Node name.

The address is a hierarchical path and you need to know the address of the model you are suppressing.

DWCurrentMacroCaller can be used when clicking a 3D Model in a DriveWorks 3D Document. This Special Variable will return the address of the model clicked.

Using the Task in a Specification Macro

This task has different types of Outputs. For more information about Outputs see Specification Macros Task Node.

Outputs are only available within Specification Macros. Currently Outputs are not available for Specification Flow.

Status Outputs

This task supports Status Outputs. These can be used to perform different actions depending on what the status outcome of the task is. For more information see Status Outputs in the Task Node Outputs section of Specification Macros Task Node.

The status output navigation is as follows:


  • Task was successful.

Success with Warnings

  • Entity type wasn't recognized.

Failed (one of the following occurred)

  • Unable to find 3D Preview with the name provided.
  • 3D Preview must be previewing a document.
  • Unable to find a Node at address provided.
  • No Entity types were specified.
  • General failure - Check the Specification report for more details.