Class CommonObject

constructor

• new CommonObject(): CommonObject

• Returns CommonObject

isValid

isValidWithLog

userStringCount

encode

• encode(): void

• ...

  Returns void

getUserString

• getUserString(key): string

• Parameters

  • key: string

    id used to retrieve the string.

  Returns string

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

  Description

  Gets user string from this geometry.

getUserStrings

• getUserStrings(): string[]

• Returns string[]

  Description

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

rdkXml

• rdkXml(): string

• ...

  Returns string

setUserString

• setUserString(key, value): boolean

• Parameters

  • key: string

    id used to retrieve this string.
  • value: string

    string associated with key.

  Returns boolean

  true if successful, false if not.

  Description

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

toJSON

• toJSON(): string

• Returns string

  Description

  Create a JSON string representation of this object

Static decode

• decode(json): CommonObject

• 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'
    }
    Copy

  Returns CommonObject

  Description

  Decodes a Rhino Object