Class RenderEnvironment

Hierarchy (view full)

RenderContent
- RenderEnvironment

Constructors

constructor

new RenderEnvironment(): RenderEnvironment
Returns RenderEnvironment
Inherited from RenderContent.constructor

Properties

autoDelete

autoDelete: boolean

childSlotName

childSlotName: string

groupId

groupId: string

hidden

hidden: boolean

id

id: string

isChild

isChild: boolean

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

isTopLevel

isTopLevel: boolean

isValid

isValid: boolean

Tests an object to see if it is valid.

isValidWithLog

isValidWithLog: [boolean, string]

...

kind

kind: string

name

name: string

notes

notes: string

plugInId

plugInId: string

reference

reference: boolean

renderEngineId

renderEngineId: string

typeId

typeId: string

typeName

typeName: string

userStringCount

userStringCount: number

Gets the amount of user strings.

Methods

childSlotAmount

childSlotAmount(child_slot_name): number
...
Parameters
- child_slot_name: string
Returns number
Inherited from RenderContent.childSlotAmount
- Defined in rhino3dm.d.ts:6069

childSlotOn

childSlotOn(child_slot_name): boolean
...
Parameters
- child_slot_name: string
Returns boolean
Inherited from RenderContent.childSlotOn
- Defined in rhino3dm.d.ts:6065

clearId

clearId(): void
Returns void
Description
Resets the HasId property of the model component to false, if possible.
Inherited from RenderContent.clearId
- 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.
Inherited from RenderContent.dataCRC
- Defined in rhino3dm.d.ts:4844

deleteChild

deleteChild(child_slot_name): boolean
...
Parameters
- child_slot_name: string
Returns boolean
Inherited from RenderContent.deleteChild
- Defined in rhino3dm.d.ts:6081

encode

encode(): void
...

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

findChild

findChild(child_slot_name): RenderContent
...
Parameters
- child_slot_name: string
Returns RenderContent
Inherited from RenderContent.findChild
- Defined in rhino3dm.d.ts:6079

getFirstChild

getFirstChild(): RenderContent
...

Returns RenderContent
Inherited from RenderContent.getFirstChild
- Defined in rhino3dm.d.ts:6057

getNextSibling

getNextSibling(): RenderContent
...

Returns RenderContent
Inherited from RenderContent.getNextSibling
- Defined in rhino3dm.d.ts:6059

getParameter

getParameter(parameter): string
...
Parameters
- parameter: string
Returns string
Inherited from RenderContent.getParameter
- Defined in rhino3dm.d.ts:6083

getParent

getParent(): RenderContent
...

Returns RenderContent
Inherited from RenderContent.getParent
- Defined in rhino3dm.d.ts:6055

getTopLevel

getTopLevel(): RenderContent
...

Returns RenderContent
Inherited from RenderContent.getTopLevel
- Defined in rhino3dm.d.ts:6061

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 RenderContent.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 RenderContent.getUserStrings
- Defined in rhino3dm.d.ts:1526

getXML

getXML(recursive): string
...
Parameters
- recursive: boolean
Returns string
Inherited from RenderContent.getXML
- Defined in rhino3dm.d.ts:6073

rdkXml

rdkXml(): string
...

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

setChild

setChild(child, child_slot_name): boolean
...
Parameters
- child: RenderContent
- child_slot_name: string
Returns boolean
Inherited from RenderContent.setChild
- Defined in rhino3dm.d.ts:6077

setChildSlotAmount

setChildSlotAmount(amount, child_slot_name): boolean
...
Parameters
- amount: number
- child_slot_name: string
Returns boolean
Inherited from RenderContent.setChildSlotAmount
- Defined in rhino3dm.d.ts:6071

setChildSlotOn

setChildSlotOn(on, child_slot_name): boolean
...
Parameters
- on: boolean
- child_slot_name: string
Returns boolean
Inherited from RenderContent.setChildSlotOn
- Defined in rhino3dm.d.ts:6067

setParameter

setParameter(key, value): boolean
...
Parameters
- key: string
- value: string
Returns boolean
Inherited from RenderContent.setParameter
- Defined in rhino3dm.d.ts:6085

setTypeName

setTypeName(name): void
...
Parameters
- name: string
Returns void
Inherited from RenderContent.setTypeName
- Defined in rhino3dm.d.ts:6063

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

setXML

setXML(xml): boolean
...
Parameters
- xml: string
Returns boolean
Inherited from RenderContent.setXML
- Defined in rhino3dm.d.ts:6075

toEnvironment

toEnvironment(): Environment
...

Returns Environment
- Defined in rhino3dm.d.ts:6090

toJSON

toJSON(): string
Returns string
Description
Create a JSON string representation of this object
Inherited from RenderContent.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 RenderContent.decode
- Defined in rhino3dm.d.ts:1508

Class RenderEnvironment

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns RenderEnvironment

Properties

autoDelete

childSlotName

groupId

hidden

id

isChild

isSystemComponent

isTopLevel

isValid

isValidWithLog

kind

name

notes

plugInId

reference

renderEngineId

tags

typeId

typeName

userStringCount

Methods

childSlotAmount

Parameters

Returns number

childSlotOn

Parameters

Returns boolean

clearId

Returns void

Description

dataCRC

Parameters

Returns number

Description

deleteChild

Parameters

Returns boolean

encode

Returns void

findChild

Parameters

Returns RenderContent

getFirstChild

Returns RenderContent

getNextSibling

Returns RenderContent

getParameter

Parameters

Returns string

getParent

Returns RenderContent

getTopLevel

Returns RenderContent

getUserString

Parameters

Returns string

Description

getUserStrings

Returns string[]

Description

getXML

Parameters

Returns string

rdkXml

Returns string

setChild

Parameters

Returns boolean

setChildSlotAmount

Parameters

`Static` decode