BodyColor3D

Now reading version 3.1. For the latest, read: BodyColor3D for version 4

This documentation page references Altium NEXUS/NEXUS Client (part of the deployed NEXUS solution), which has been discontinued. All your PCB design, data management and collaboration needs can now be delivered by Altium Designer and a connected Altium 365 Workspace. Check out the FAQs page for more information.

Parent page: PCB Query Functions - Fields

Summary

Returns all 3D body objects whose Body 3-D Color property complies with the Query.

Syntax

BodyColor3D : Numeric_String
BodyColor3D : Number

The BodyColor3D keyword can always be used in conjunction with a Numeric_String. It can alternatively be used in conjunction with a Number, but only when all other objects (which do not have a Body 3-D Color property) have been totally excluded by one or more preceding entries within the Query expression. Either use entries in the expression such as BodyColor3D <> '', or BodyColor3D > ''. Alternatively, use entries specifically targeting 3D body objects, such as IsComponentBody.

The color corresponding to a particular number can be deduced from the following relationship:

65536 * Blue + 256 * Green + Red

where the Blue, Green, and Red components each have a value between 0 and 255 (inclusive).

When the BodyColor3D keyword can be used in conjunction with a Number, it is possible to individually evaluate the values of each of the Body 3-D Color property's Blue, Green, and Red components, by using the following constructs:

  • Blue = Body 3-D Color Div 65536
  • Green = Body 3-D Color Div 256 Mod 256
  • Red = Body 3-D Color Mod 256

Example Usage

BodyColor3D = '0'
BodyColor3D <> '' && BodyColor3D = 0

Returns all 3D body objects whose Body 3-D Color property is 0 (which corresponds to values of Blue = 0, Green = 0, and Red = 0).

BodyColor3D = '16711680'
BodyColor3D > '' && BodyColor3D = 16711680

Returns all 3D body objects whose Body 3-D Color property is 16711680 (which corresponds to values of Blue = 255, Green = 0, and Red = 0).

BodyColor3D <> '16777215'
Returns all 3D body objects except those whose Body 3-D Color property is 16777215 (which corresponds to values of Blue = 255, Green = 255, and Red = 255).

IsComponentBody && BodyColor3D Div 65536 <= 192
Returns all 3D body objects whose Body 3-D Color property's Blue component has a value which is less than or equal to 192.

Tips

  1. The Body 3-D Color property is only defined for 3D body objects.

 

If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.