SilverScreen Solid Modeler

SYMBOL_NODE

SYMBOL_NODE

Previous topic Next topic  

SYMBOL_NODE

Previous topic Next topic JavaScript is required for the print function  

SilverSharpAPI

 

SilverSharp.SYMBOL_NODE

 

Structure

A SilverSharp.SYMBOL_NODE stores the information associated with a SilverScreen symbol entity

 

 

 

C# Code

 

 class SYMBOL_NODE sealed : BOS_NODE

    {

    SYMBOL_NODE(SYMBOL_NODE  rhs);

    SYMBOL_NODE(string symbol_path);

 

    [System.Flags]

    enum SymbolBits

       {

       FORCE_PCOLOR  = 0x0001,

       FORCE_PSCALE  = 0x0002,

       FORCE_PATTERN = 0x0004,

       FORCE_SCOLOR  = 0x0008,

       FORCE_ANY     = 0x000f,

       };    

 

 

    readonly MODEL_NODE  model;

 

    property SymbolBits  bits_surface            { get; }

 

    property TagList     Tags                    { get; }

    property TAG_NODE    first_tag               { get; }

 

    property MATRIX      matrix                  { get; }

    property double      pattern_scale           { get; }

 

    property SchemaList  Schemas                 { get; }

    property SCHEMA_NODE first_schema            { get; }

 

    property string      model_name              { get; }

    property string      library_name            { get; }

 

    property SS_RGB      pattern_rgb             { get; }

    property SS_RGB      surface_rgb             { get; }

    property int         surface_pattern_number  { get; }

    };

 

 

 

Properties

The following read-only properties mimic the purpose of their counter-parts in the SilverC SYMBOL_NODE:

 

Member

Description

matrix

The transformation matrix that is applied to the model geometry to render the symbol.

pattern_scale

A scaling factor that is applied to all patterns of all primitives contained by the symbol when FORCE_PSCALE is enabled in bits_surface

model

A reference to the model geometry that represents the symbol. The geometry is in model space and must be transformed through the symbol matrix to be mapped to world space.

first_schema

A SCHEMA_NODE reference to the first schema associated with the symbol. SilverSharp developers may prefer using Schemas.

first_tag

A TAG_NODE reference to the first tag associated with the symbol. SilverSharp developers may prefer using Tags.

model_name

The name of the model

library_name

The model library in which the model is contained.

pattern_rgb

The color that is used to over-ride all patterns of all primitives contained by the symbol when FORCE_PCOLOR is enabled in bits_surface

surface_rgb

The color that is used to over-ride all surface colors of all primitives contained by the symbol when FORCE_SCOLOR is enabled in bits_surface

bits_surface

A bit flag that controls rendering properties, and whose meaning is

 

Value

Meaning

FORCE_PCOLOR

Force a pattern color on a symbol

FORCE_PSCALE

Force a pattern scale on a symbol

FORCE_PATTERN

Force a pattern on a symbol

FORCE_SCOLOR

Force a surface color on a symbol

surface_pattern_number

A pattern that is applied to all closed primitives contained in the symbol when FORCE_PATTERN is enabled in bits_surface

 

The following read-only properties extend SYMBOL_NODE for SilverSharp:

 

Member

Description

Tags

Enumerates every TAG_NODE from the tag table of the symbol entity

Schemas

Enumerates every SCHEMA_NODE from the schema table of the symbol entity

 

 

Methods

Name

Description

SYMBOL_NODE

Constructors to initialize the object

 

 

Remarks

A SilverSharp.SYMBOL_NODE inherits from a SilverSharp.BOS_NODE and therefore includes those properties and methods as well; for instance, Path, Type, and bits1 are inherited properties of a SilverSharp.BOS_NODE.

 

Note: A SilverSharp.SYMBOL_NODE is a SilverSharp.BOS_NODE, but the reverse is not true.

 

 

See Also

SilverC SYMBOL_NODE