Selva Compute API Reference - v2.1.0
    Preparing search index...

    Class ModelComponent

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    id isSystemComponent isValid isValidWithLog userStringCount

    Methods

    clearId dataCRC encode getUserString getUserStrings rdkXml setUserString toJSON decode

    Constructors

    Properties

    id: string

    Gets or sets the ID of the current instance.

    isSystemComponent: boolean

    True if this model component is a system constant. An incomplete list of system constant model components is below:ON_ModelComponent::Unset ON_InstanceDefinition::Empty ON_Linetype::UnsetON_Linetype::ContinuousON_Linetype::ByLayerON_Linetype::ByParent ON_Layer::UnsetON_Layer::Default ON_TextStyle::UnsetON_TextStyle::DefaultON_TextStyle::ByLayerON_TextStyle::ByParent ON_DimStyle::UnsetON_DimStyle::DefaultON_DimStyle::DefaultInchDecimalON_DimStyle::DefaultInchFractionalON_DimStyle::DefaultFootInchArchitectureON_DimStyle::DefaultMillimeterSmallON_DimStyle::DefaultMillimeterLargeON_DimStyle::DefaultMillimeterArchitecture

    isValid: boolean

    Tests an object to see if it is valid.

    isValidWithLog: [boolean, string]

    ...

    userStringCount: number

    Gets the amount of user strings.

    Methods

    • Returns void

      Resets the HasId property of the model component to false, if possible.

    • Parameters

      • currentRemainder: number

        The current remainder value.

      Returns number

      The updated remainder value.

      Increments the Cyclic Redundancy Check value by this instance.

    • ...

      Returns void

    • Parameters

      • key: string

        id used to retrieve the string.

      Returns string

      string associated with the key if successful. null if no key was found.

      Gets user string from this geometry.

    • Returns string[]

      Gets a copy of all (user key string, user value string) pairs attached to this geometry.

    • ...

      Returns string

    • Parameters

      • key: string

        id used to retrieve this string.

      • value: string

        string associated with key.

      Returns boolean

      true if successful, false if not.

      Attach a user string (key,value combination) to this geometry.

    • Returns string

      Create a JSON string representation of this object

    • Parameters

      • json: object

        A json formatted object in the following format (values are orientative):

        {
        		version: 10000,
        		archive3dm: 60,
        		opennurbs: -1877964208,
        		data: 'encoded 3dm object data'
        }

      Returns CommonObject

      Decodes a Rhino Object

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods