SilverScreen Solid Modeler

BOS_NODE

BOS_NODE

Previous topic Next topic  

BOS_NODE

Previous topic Next topic JavaScript is required for the print function  

SilverSharpAPI

 

SilverSharp.BOS_NODE

 

Structure

All entities in SilverScreen derive from a SilverSharp.BOS_NODE.

 

 

 

C# Code

 

 abstract class BOS_NODE

    {

    string ToString();

    bool   Equals(System.Object obj);

 

    property string     name               { get; }

    property BOS_NODE   next_bos           { get; }

    property BOS_NODE   prev_bos           { get; }

    property BOS_NODE   parent             { get; }

    property SS_XYZ     local_base         { get; }

    property SS_XYZ     local_horz         { get; }

    property SS_XYZ     local_vert         { get; }

    property SS_XYZ     high               { get; }

    property SS_XYZ     low                { get; }

    property SS_XYZ     center             { get; }

    property SS_XYZ     top_axis           { get; }

    property SS_XYZ     bottom_axis        { get; }

    property BosBits1   bits1              { get; }

    property BosBits2   bits2              { get; }

    property SS_RGB     force_rgb          { get; }

    property WidthStyle force_width_style  { get; }

 

    property bool IsObject       { get; }

    property bool IsBlock        { get; }

    property bool IsSymbol       { get; }

    property bool IsDetail       { get; }

    property bool IsTextline     { get; }

    property bool IsSolidObject  { get; }

    property bool IsVisible      { get; }

    property bool IsInvisible    { get; }

    property bool IsSprite       { get; }

 

    property string Path  { get; }

    property string Type  { get; }

       

    static bool IsEmpty(BOS_NODE bn);

    };

 

 

 

Properties

The following read-only properties mimic the purpose of their counter-parts in the SilverC BOS_NODE.

 

Member

Description

bits1

See the BosBits1 enumeration for acceptable values

bits2

See the BosBits2 enumeration for acceptable values

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. When BITS_FORCE_LINESTYLE is set on bits1, this member contains a linestyle id that will over-ride those set by child nodes.

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.

next_bos

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

prev_bos

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

parent

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

 

The following read-only properties extend BOS_NODE for SilverSharp:

 

Name

Description

IsObject

IsBlock

IsSymbol

IsDetail

IsTextline

IsSolidObject

IsVisible

IsInvisible

IsSprite

Property is true if entity is the type indicated by the property name, and otherwise false.

Path

A string that is the SilverScreen path to the primitive (i.e. "\obj1.1")

Type

A string that is the English keyword for the primitive type (i.e. "object", or "block")

 

 

Methods

Name

Description

ToString

Formats the entity as a string (i.e. "object \obj1")

Equals

Checks for equality with an object instance

IsEmpty

Checks if the entity reference refers to an empty entity

 

 

See Also

SilverC BOS_NODE, Entity Types, BosBits1, BosBits2