SilverScreen Solid Modeler

BOS_NODE        

BOS_NODE        

Previous topic Next topic  

BOS_NODE        

Previous topic Next topic JavaScript is required for the print function  

SilverScreenAPI

 

BOS_NODE

 

Structure

A BOS_NODE is the base type for all entity-level nodes in the SilverScreen drawing hierarchy

 

 

 struct  BOS_NODE

    {

    USINT32    bits1;

    USINT32    bits2;

    SS_XYZ     high;

    SS_XYZ     low;

    SS_XYZ     center;

    SS_XYZ     top_axis;

    SS_XYZ     bottom_axis;

    SS_XYZ     local_horz;

    SS_XYZ     local_vert;

    SS_XYZ     local_base;

    NAME       name;

    USINT      force_width_style;

    RGB        force_rgb;

    USINT32    visibility_settings;

    BOS_NODE   *next_bos;

    BOS_NODE   *prev_bos;

    BLOCK_NODE *parent;

    };

 

 

 

Members

Member

Description

bits1

Entity-level bit flags with the following values:

 

Constant

Meaning

BITS_BLOCK

The BOS_NODE is a block

BITS_OBJECT

The BOS_NODE entity is an object

BITS_SYMBOL

The BOS_NODE entity is a symbol

BITS_TEXT

The BOS_NODE entity is a text-line

BITS_DETAIL

The BOS_NODE entity is a detail



BITS_VISIBLE

The BOS_NODE entity has visibility enabled

BITS_HIGHLOW

The BOS_NODE entity has accurate extents in 'high' and 'low' members

BITS_AXIS

The BOS_NODE entity has an axis of rotation in 'top_axis' and 'bottom_axis' members

BITS_CENTER

The BOS_NODE entity has a basepoint in 'center'

BITS_FONTSYMBOL

The BOS_NODE entity is a symbol representing a character in a font library

BITS_CHAR

The BOS_NODE entity is an object representing a character in a font library



BITS_FORCE_WIDTH

The 'force_width_style' member has a width that will over-ride any width of child nodes

BITS_FORCE_LINESTYLE

The 'force_width_style' member has a style that will over-ride any linestyle of child nodes

BITS_FORCE_COLOR

The 'force_rgb' member is a color that will over-ride any edge color of child nodes

BITS_FORCE

A value that can be and'd into the 'bits1' member to determine if any force is active

 

bits2

Entity-level bit flags with the following values

 

Constant

Meaning

BITS_ANNOTATE

When 'bits1' has the BITS_BLOCK flag and this flag is also set, the BOS_NODE entity is an annotation block

BITS_VISI_SAVE

Visibility information has been stored with the entity by the record_visibility command, or via the menu

BITS_SPHERE

This entity is an object that is a sphere

BITS_PRISM

This entity is an object that is a prism

BITS_CYLINDER

This entity is an object that is a cylinder

BITS_CONE

This entity is an object that is a cone

BITS_TRUNCONE

This entity is an object that is a truncated cone

BITS_PATTERN_COLOR

The pattern color stored in this entity will be applied to child nodes

BITS_SOLID

This entity is an object that has been validated as a solid model

 

high

If BITS_HIGHLOW is set on bits1, this member contains the maximum bounds of the entity in w-space.

low

If BITS_HIGHLOW is set on bits1, this member contains the minimum bounds of the entity in w-space.

center

If BITS_CENTER is set on bits1, this member contains the basepoint of the entity

top_axis

If BITS_AXIS is set on bits1, this member contains the top of the axis of rotation for the entity.

bottom_axis

If BITS_AXIS is set on bits1, this member contains the bottom of the axis of rotation for the entity.

local_horz

This is the direction of the x-axis of the entity space (e-space) for the entity. It must be added to 'local_base' to obtain a 3D coordinate.

local_vert

This is the direction of the y-axis of the entity space (e-space) for the entity. It must be added to 'local_base' to obtain a 3D coordinate.

local_base

This is the basepoint of the entity space (e-space) for the entity.

name

This is the name of the entity.

force_width_style

When BITS_FORCE_WIDTH is set on bits1, this member contains a line width that will over-ride those set by child nodes. The value may be examined with the LINE_WIDTH macro. When BITS_FORCE_LINESTYLE is set on bits1, this member contains a linestyle id that will over-ride those set by child nodes. The value may be examined with the LINE_STYLE macro.

force_rgb

When BITS_FORCE_COLOR is set on bits1, this member contains an edge color that will over-ride those set by child nodes. The color components may be examined with the RED_COLOR, GREEN_COLOR, and BLUE_COLOR macros.

visibility_settings

If BITS_VISI_SAVE is set on bits2, this member stores visibility states used by the record_visibility and reset_visibility command.

next_bos

This is a pointer to the next sibling node in the parent block.

prev_bos

This is a pointer to the previous sibling node in the parent block.

parent

This is a pointer to the block that contains the entity.

 

See Also

LINE_STYLE, LINE_WIDTH, get_bos, bos_extents, record_visibility, reset_visibility

 

Header

silver.h, ssnodes.h