new CorridorGraphics(options)

Used to extrude specific cross-sectional shapes along a three-dimensional path to generate volume classes

Name Type Description

options

Object

optional

Object is an object that contains the following properties:

Name	Type	Default	Description
`show`	Property	true	optional Boolean attribute, used to specify the visibility of channels.
`positions`	Property		optional The Cartesian3 array property defines the three-dimensional path of the channel.
`width`	Property		optional The number attribute specifies the distance between the edges of the channel.
`height`	Property	0	optional The number attribute specifies the height of the channel equivalent to the ellipsoid surface.
`heightReference`	Property	HeightReference.NONE	optional The HeightReference property specifies the relative reference height of the height in the Entity.
`extrudedHeight`	Property		optional The number attribute specifies the height of the channel extrusion surface relative to the ellipsoid surface.
`extrudedHeightReference`	Property	HeightReference.NONE	optional Property that specifies the relative reference point for CorridorGraphics # extradedHeight.
`cornerType`	Property	CornerType.ROUNDED	optional The CornerType property is used to specify the style of channel corners.
`granularity`	Property	SuperMap3D.Math.RADIANS_PER_DEGREE	optional The numerical attribute specifies the sampling distance for latitude and longitude.
`fill`	Property	true	optional Boolean property, used to specify whether the channel is filled with the provided material.
`material`	MaterialProperty	Color.WHITE	optional Material properties, used to specify the material for filling channels.
`outline`	Property	false	optional Boolean property, used to specify whether to display the outline of the channel.
`outlineColor`	Property	Color.BLACK	optional The Color property specifies the color of the contour.
`outlineWidth`	Property	1.0	optional The number attribute specifies the width of the contour.
`shadows`	Property	ShadowMode.DISABLED	optional Enumeration properties used to specify whether a channel casts or receives shadows from each light source.
`distanceDisplayCondition`	Property		optional Attribute, specifying how far the channel is displayed from the camera.
`classificationType`	Property	ClassificationType.BOTH	optional An enum Property specifying whether this corridor will classify terrain, 3D Tiles, or both when on the ground.
`zIndex`	ConstantProperty		optional Attribute, used to specify the zIndex of the channel, which is used for sorting. This effect only works when CorridorGraphics # height and CorridorGraphics # extradedHeight are undefined and the channel is static.

See:

Entity

Members

classificationTypeProperty

Get or set the ClassityType property, specifying whether the channel classifies terrain, 3D tiles, or both.

Default Value:

cornerTypeProperty

Get or set the CornerType property to specify the type of corner.

Default Value:

readonly definitionChangedEvent

Get events. This event is thrown when the value of a property or sub property is modified, or when the definition is modified.

distanceDisplayConditionProperty

Get or set the DistanceDisplayCondition property to specify how far away the channel should be displayed from the camera.

extrudedHeightProperty

Get or set the number property, which specifies the altitude at which the channel is extruded. After setting this attribute, a channel volume will be created. This channel starts from CorridorGraphics # height and ends at CorridorGraphics # extradedHeight.

extrudedHeightReferenceProperty

Get or set a property that specifies the reference point HeightReference for the extrusion height

Default Value:

fillProperty

Get or set boolean property to specify whether to fill the channel with the provided material.

Default Value:

granularityProperty

Get or set the number property, which specifies the sampling distance between each latitude and longitude point.

Default Value:

heightProperty

Get or set the number property to specify the height of the channel.

Default Value:

heightReferenceProperty

Get or set the HeightReference property.

Default Value:

materialMaterialProperty

Get or set the MaterialProperty property to specify the material used to fill the channel.

Default Value:

outlineProperty

Gets or sets Boolean properties to specify whether to display channel contours.

Default Value:

outlineColorProperty

Get or set the Color property to specify the color of the contour.

Default Value:

outlineWidthProperty

Get or set the number property to specify the contour width.

Default Value:

positionsProperty

Get or set a Cartesian3 array that specifies the three-dimensional path of a channel.

shadowsProperty

Gets or sets enumeration properties to specify whether a channel casts or receives shadows from each light source.

Default Value:

showProperty

Get the visibility of the set channel, of type boolean.

Default Value:

widthProperty

Get or set the number property to specify the width of the channel.

zIndexConstantProperty

Get or set the number property, which specifies the zIndex of the channel, and zIndex specifies the order of the channel in the z-direction. This property only has an effect if the channel is static and the CorridorGraphics # height and CorridorGraphics # extradedHeight properties are not specified.

Default Value:

Methods

clone(result){CorridorGraphics}

Copy instance

Name	Type	Description
`result`	CorridorGraphics	optional The object that stores the copied results

Returns:

Type	Description
CorridorGraphics	If input parameters are provided, return the modified input parameter object. If no input parameters are provided, return a new instance.

merge(source)

Assign the attribute values corresponding to the source object to all unspecified attributes of this instance.

Name	Type	Description
`source`	CorridorGraphics	An object that provides attribute values.

Class: CorridorGraphics