Class ModelComponent

Hierarchy (view full)

CommonObject
- ModelComponent

Index

Constructors

constructor

new ModelComponent(): ModelComponent
Returns ModelComponent
Inherited from CommonObject.constructor

Properties

id

id: string

Gets or sets the ID of the current instance.

isSystemComponent

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

isValid: boolean

Tests an object to see if it is valid.

isValidWithLog

isValidWithLog: [boolean, string]

...

userStringCount

userStringCount: number

Gets the amount of user strings.

Methods

clearId

clearId(): void
Returns void
Description
Resets the HasId property of the model component to false, if possible.
- Defined in rhino3dm.d.ts:4849

dataCRC

dataCRC(currentRemainder): number
Parameters
- currentRemainder: number
  The current remainder value.
Returns number
The updated remainder value.

Description
Increments the Cyclic Redundancy Check value by this instance.
- Defined in rhino3dm.d.ts:4844

encode

encode(): void
...

Returns void
Inherited from CommonObject.encode
- Defined in rhino3dm.d.ts:1489

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.
Inherited from CommonObject.getUserString
- Defined in rhino3dm.d.ts:1521

getUserStrings

getUserStrings(): string[]
Returns string[]
Description
Gets a copy of all (user key string, user value string) pairs attached to this geometry.
Inherited from CommonObject.getUserStrings
- Defined in rhino3dm.d.ts:1526

rdkXml

rdkXml(): string
...

Returns string
Inherited from CommonObject.rdkXml
- Defined in rhino3dm.d.ts:1528

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.
Inherited from CommonObject.setUserString
- Defined in rhino3dm.d.ts:1515

toJSON

toJSON(): string
Returns string
Description
Create a JSON string representation of this object
Inherited from CommonObject.toJSON
- Defined in rhino3dm.d.ts:1494

`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'
}
```
Returns CommonObject
Description
Decodes a Rhino Object
Inherited from CommonObject.decode
- Defined in rhino3dm.d.ts:1508

Class ModelComponent

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ModelComponent

Properties

id

isSystemComponent

isValid

isValidWithLog

userStringCount

Methods

clearId

Returns void

Description

dataCRC

Parameters

Returns number

Description

encode

Returns void

getUserString

Parameters

Returns string

Description

getUserStrings

Returns string[]

Description

rdkXml

Returns string

setUserString

Parameters

Returns boolean

Description

toJSON

Returns string

Description

Static decode

Parameters

Returns CommonObject

Description

Settings

Member Visibility

Theme

On This Page

`Static` decode