Search
Preparing search index...
The search index is not available
OpenCascade.js - v2.0.0-beta.533428a
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
OpenCascade.js - v2.0.0-beta.533428a
V3d_Viewer
Class V3d_Viewer
Hierarchy
Standard_Transient
V3d_Viewer
Index
Constructors
constructor
Methods
Activate
Grid
Active
Light
Active
Light
Iterator
Active
Lights
Active
View
Active
View
Iterator
Active
Views
Add
Light
AddZLayer
Circular
Grid
Graphic
Values
Circular
Grid
Values
Computed
Mode
Create
View
Deactivate
Grid
Decrement
Ref
Counter
Default
Background
Color
Default
Bg
Gradient
Colors
Default
Computed
Mode
Default
Rendering
Params
Default
Shading
Model
Default
Type
Of
View
Default
View
Proj
Default
View
Size
Default
Visualization
Defined
Light
Defined
Light
Iterator
Defined
Lights
Defined
View
Defined
View
Iterator
Defined
Views
Del
Light
Delete
Display
Privileged
Plane
Driver
Dump
Json
Dynamic
Type
Erase
Get
AllZLayers
Get
Gradient
Background
Get
Ref
Count
Grid
Draw
Mode
Grid
Echo
Grid
Type
Grid_
1
Grid_
2
Hide
Grid
Echo
If
More
Views
Increment
Ref
Counter
Init
Active
Lights
Init
Active
Views
Init
Defined
Lights
Init
Defined
Views
Insert
Layer
After
Insert
Layer
Before
Invalidate
Is
Active
Is
Global
Light
Is
Grid
Active
Is
Instance_
1
Is
Instance_
2
Is
Kind_
1
Is
Kind_
2
Last
Active
View
More
Active
Lights
More
Active
Views
More
Defined
Lights
More
Defined
Views
Next
Active
Lights
Next
Active
Views
Next
Defined
Lights
Next
Defined
Views
Privileged
Plane
Rectangular
Grid
Graphic
Values
Rectangular
Grid
Values
Redraw
Redraw
Immediate
Remove
RemoveZLayer
Set
Circular
Grid
Graphic
Values
Set
Circular
Grid
Values
Set
Computed
Mode
Set
Default
Background
Color
Set
Default
Bg
Gradient
Colors
Set
Default
Computed
Mode
Set
Default
Lights
Set
Default
Rendering
Params
Set
Default
Shading
Model
Set
Default
Type
Of
View
Set
Default
View
Proj
Set
Default
View
Size
Set
Default
Visualization
Set
Grid
Echo_
1
Set
Grid
Echo_
2
Set
Light
Off_
1
Set
Light
Off_
2
Set
Light
On_
1
Set
Light
On_
2
Set
Privileged
Plane
Set
Rectangular
Grid
Graphic
Values
Set
Rectangular
Grid
Values
Set
View
Off_
1
Set
View
Off_
2
Set
View
On_
1
Set
View
On_
2
SetZLayer
Settings
Show
Grid
Echo
Structure
Manager
This
Un
Highlight
Update
Update
Lights
ZLayer
Settings
delete
get_
type_
descriptor
get_
type_
name
Constructors
constructor
new
V3d_
Viewer
(
theDriver
:
Handle_Graphic3d_GraphicDriver
)
:
V3d_Viewer
Parameters
theDriver:
Handle_Graphic3d_GraphicDriver
Returns
V3d_Viewer
Methods
Activate
Grid
Activate
Grid
(
aGridType
:
Aspect_GridType
, aGridDrawMode
:
Aspect_GridDrawMode
)
:
void
Parameters
aGridType:
Aspect_GridType
aGridDrawMode:
Aspect_GridDrawMode
Returns
void
Active
Light
Active
Light
(
)
:
any
Returns
any
Active
Light
Iterator
Active
Light
Iterator
(
)
:
V3d_ListOfLightIterator
Returns
V3d_ListOfLightIterator
Active
Lights
Active
Lights
(
)
:
V3d_ListOfLight
Returns
V3d_ListOfLight
Active
View
Active
View
(
)
:
Handle_V3d_View
Returns
Handle_V3d_View
Active
View
Iterator
Active
View
Iterator
(
)
:
V3d_ListOfViewIterator
Returns
V3d_ListOfViewIterator
Active
Views
Active
Views
(
)
:
V3d_ListOfView
Returns
V3d_ListOfView
Add
Light
Add
Light
(
theLight
:
any
)
:
void
Parameters
theLight:
any
Returns
void
AddZLayer
AddZLayer
(
theLayerId
:
Graphic3d_ZLayerId
, theSettings
:
Graphic3d_ZLayerSettings
)
:
boolean
Parameters
theLayerId:
Graphic3d_ZLayerId
theSettings:
Graphic3d_ZLayerSettings
Returns
boolean
Circular
Grid
Graphic
Values
Circular
Grid
Graphic
Values
(
theRadius
:
number
, theOffSet
:
number
)
:
void
Parameters
theRadius:
number
theOffSet:
number
Returns
void
Circular
Grid
Values
Circular
Grid
Values
(
theXOrigin
:
number
, theYOrigin
:
number
, theRadiusStep
:
number
, theDivisionNumber
:
Graphic3d_ZLayerId
, theRotationAngle
:
number
)
:
void
Parameters
theXOrigin:
number
theYOrigin:
number
theRadiusStep:
number
theDivisionNumber:
Graphic3d_ZLayerId
theRotationAngle:
number
Returns
void
Computed
Mode
Computed
Mode
(
)
:
boolean
Returns
boolean
Create
View
Create
View
(
)
:
Handle_V3d_View
Returns
Handle_V3d_View
Deactivate
Grid
Deactivate
Grid
(
)
:
void
Returns
void
Decrement
Ref
Counter
Decrement
Ref
Counter
(
)
:
Graphic3d_ZLayerId
Returns
Graphic3d_ZLayerId
Default
Background
Color
Default
Background
Color
(
)
:
Quantity_Color
Returns
Quantity_Color
Default
Bg
Gradient
Colors
Default
Bg
Gradient
Colors
(
theColor1
:
Quantity_Color
, theColor2
:
Quantity_Color
)
:
void
Parameters
theColor1:
Quantity_Color
theColor2:
Quantity_Color
Returns
void
Default
Computed
Mode
Default
Computed
Mode
(
)
:
boolean
Returns
boolean
Default
Rendering
Params
Default
Rendering
Params
(
)
:
Graphic3d_RenderingParams
Returns
Graphic3d_RenderingParams
Default
Shading
Model
Default
Shading
Model
(
)
:
V3d_TypeOfShadingModel
Returns
V3d_TypeOfShadingModel
Default
Type
Of
View
Default
Type
Of
View
(
)
:
V3d_TypeOfView
Returns
V3d_TypeOfView
Default
View
Proj
Default
View
Proj
(
)
:
V3d_TypeOfOrientation
Returns
V3d_TypeOfOrientation
Default
View
Size
Default
View
Size
(
)
:
number
Returns
number
Default
Visualization
Default
Visualization
(
)
:
V3d_TypeOfVisualization
Returns
V3d_TypeOfVisualization
Defined
Light
Defined
Light
(
)
:
any
Returns
any
Defined
Light
Iterator
Defined
Light
Iterator
(
)
:
V3d_ListOfLightIterator
Returns
V3d_ListOfLightIterator
Defined
Lights
Defined
Lights
(
)
:
V3d_ListOfLight
Returns
V3d_ListOfLight
Defined
View
Defined
View
(
)
:
Handle_V3d_View
Returns
Handle_V3d_View
Defined
View
Iterator
Defined
View
Iterator
(
)
:
V3d_ListOfViewIterator
Returns
V3d_ListOfViewIterator
Defined
Views
Defined
Views
(
)
:
V3d_ListOfView
Returns
V3d_ListOfView
Del
Light
Del
Light
(
theLight
:
any
)
:
void
Parameters
theLight:
any
Returns
void
Delete
Delete
(
)
:
void
Returns
void
Display
Privileged
Plane
Display
Privileged
Plane
(
theOnOff
:
boolean
, theSize
:
number
)
:
void
Parameters
theOnOff:
boolean
theSize:
number
Returns
void
Driver
Driver
(
)
:
Handle_Graphic3d_GraphicDriver
Returns
Handle_Graphic3d_GraphicDriver
Dump
Json
Dump
Json
(
theOStream
:
Standard_OStream
, theDepth
:
Graphic3d_ZLayerId
)
:
void
Parameters
theOStream:
Standard_OStream
theDepth:
Graphic3d_ZLayerId
Returns
void
Dynamic
Type
Dynamic
Type
(
)
:
Handle_Standard_Type
Returns
Handle_Standard_Type
Erase
Erase
(
)
:
void
Returns
void
Get
AllZLayers
Get
AllZLayers
(
theLayerSeq
:
TColStd_SequenceOfInteger
)
:
void
Parameters
theLayerSeq:
TColStd_SequenceOfInteger
Returns
void
Get
Gradient
Background
Get
Gradient
Background
(
)
:
Aspect_GradientBackground
Returns
Aspect_GradientBackground
Get
Ref
Count
Get
Ref
Count
(
)
:
Graphic3d_ZLayerId
Returns
Graphic3d_ZLayerId
Grid
Draw
Mode
Grid
Draw
Mode
(
)
:
Aspect_GridDrawMode
Returns
Aspect_GridDrawMode
Grid
Echo
Grid
Echo
(
)
:
boolean
Returns
boolean
Grid
Type
Grid
Type
(
)
:
Aspect_GridType
Returns
Aspect_GridType
Grid_
1
Grid_
1
(
theToCreate
:
boolean
)
:
Handle_Aspect_Grid
Parameters
theToCreate:
boolean
Returns
Handle_Aspect_Grid
Grid_
2
Grid_
2
(
theGridType
:
Aspect_GridType
, theToCreate
:
boolean
)
:
Handle_Aspect_Grid
Parameters
theGridType:
Aspect_GridType
theToCreate:
boolean
Returns
Handle_Aspect_Grid
Hide
Grid
Echo
Hide
Grid
Echo
(
theView
:
Handle_V3d_View
)
:
void
Parameters
theView:
Handle_V3d_View
Returns
void
If
More
Views
If
More
Views
(
)
:
boolean
Returns
boolean
Increment
Ref
Counter
Increment
Ref
Counter
(
)
:
void
Returns
void
Init
Active
Lights
Init
Active
Lights
(
)
:
void
Returns
void
Init
Active
Views
Init
Active
Views
(
)
:
void
Returns
void
Init
Defined
Lights
Init
Defined
Lights
(
)
:
void
Returns
void
Init
Defined
Views
Init
Defined
Views
(
)
:
void
Returns
void
Insert
Layer
After
Insert
Layer
After
(
theNewLayerId
:
Graphic3d_ZLayerId
, theSettings
:
Graphic3d_ZLayerSettings
, theLayerBefore
:
Graphic3d_ZLayerId
)
:
boolean
Parameters
theNewLayerId:
Graphic3d_ZLayerId
theSettings:
Graphic3d_ZLayerSettings
theLayerBefore:
Graphic3d_ZLayerId
Returns
boolean
Insert
Layer
Before
Insert
Layer
Before
(
theNewLayerId
:
Graphic3d_ZLayerId
, theSettings
:
Graphic3d_ZLayerSettings
, theLayerAfter
:
Graphic3d_ZLayerId
)
:
boolean
Parameters
theNewLayerId:
Graphic3d_ZLayerId
theSettings:
Graphic3d_ZLayerSettings
theLayerAfter:
Graphic3d_ZLayerId
Returns
boolean
Invalidate
Invalidate
(
)
:
void
Returns
void
Is
Active
Is
Active
(
)
:
boolean
Returns
boolean
Is
Global
Light
Is
Global
Light
(
TheLight
:
any
)
:
boolean
Parameters
TheLight:
any
Returns
boolean
Is
Grid
Active
Is
Grid
Active
(
)
:
boolean
Returns
boolean
Is
Instance_
1
Is
Instance_
1
(
theType
:
Handle_Standard_Type
)
:
boolean
Parameters
theType:
Handle_Standard_Type
Returns
boolean
Is
Instance_
2
Is
Instance_
2
(
theTypeName
:
string
)
:
boolean
Parameters
theTypeName:
string
Returns
boolean
Is
Kind_
1
Is
Kind_
1
(
theType
:
Handle_Standard_Type
)
:
boolean
Parameters
theType:
Handle_Standard_Type
Returns
boolean
Is
Kind_
2
Is
Kind_
2
(
theTypeName
:
string
)
:
boolean
Parameters
theTypeName:
string
Returns
boolean
Last
Active
View
Last
Active
View
(
)
:
boolean
Returns
boolean
More
Active
Lights
More
Active
Lights
(
)
:
boolean
Returns
boolean
More
Active
Views
More
Active
Views
(
)
:
boolean
Returns
boolean
More
Defined
Lights
More
Defined
Lights
(
)
:
boolean
Returns
boolean
More
Defined
Views
More
Defined
Views
(
)
:
boolean
Returns
boolean
Next
Active
Lights
Next
Active
Lights
(
)
:
void
Returns
void
Next
Active
Views
Next
Active
Views
(
)
:
void
Returns
void
Next
Defined
Lights
Next
Defined
Lights
(
)
:
void
Returns
void
Next
Defined
Views
Next
Defined
Views
(
)
:
void
Returns
void
Privileged
Plane
Privileged
Plane
(
)
:
gp_Ax3
Returns
gp_Ax3
Rectangular
Grid
Graphic
Values
Rectangular
Grid
Graphic
Values
(
theXSize
:
number
, theYSize
:
number
, theOffSet
:
number
)
:
void
Parameters
theXSize:
number
theYSize:
number
theOffSet:
number
Returns
void
Rectangular
Grid
Values
Rectangular
Grid
Values
(
theXOrigin
:
number
, theYOrigin
:
number
, theXStep
:
number
, theYStep
:
number
, theRotationAngle
:
number
)
:
void
Parameters
theXOrigin:
number
theYOrigin:
number
theXStep:
number
theYStep:
number
theRotationAngle:
number
Returns
void
Redraw
Redraw
(
)
:
void
Returns
void
Redraw
Immediate
Redraw
Immediate
(
)
:
void
Returns
void
Remove
Remove
(
)
:
void
Returns
void
RemoveZLayer
RemoveZLayer
(
theLayerId
:
Graphic3d_ZLayerId
)
:
boolean
Parameters
theLayerId:
Graphic3d_ZLayerId
Returns
boolean
Set
Circular
Grid
Graphic
Values
Set
Circular
Grid
Graphic
Values
(
Radius
:
number
, OffSet
:
number
)
:
void
Parameters
Radius:
number
OffSet:
number
Returns
void
Set
Circular
Grid
Values
Set
Circular
Grid
Values
(
XOrigin
:
number
, YOrigin
:
number
, RadiusStep
:
number
, DivisionNumber
:
Graphic3d_ZLayerId
, RotationAngle
:
number
)
:
void
Parameters
XOrigin:
number
YOrigin:
number
RadiusStep:
number
DivisionNumber:
Graphic3d_ZLayerId
RotationAngle:
number
Returns
void
Set
Computed
Mode
Set
Computed
Mode
(
theMode
:
boolean
)
:
void
Parameters
theMode:
boolean
Returns
void
Set
Default
Background
Color
Set
Default
Background
Color
(
theColor
:
Quantity_Color
)
:
void
Parameters
theColor:
Quantity_Color
Returns
void
Set
Default
Bg
Gradient
Colors
Set
Default
Bg
Gradient
Colors
(
theColor1
:
Quantity_Color
, theColor2
:
Quantity_Color
, theFillStyle
:
Aspect_GradientFillMethod
)
:
void
Parameters
theColor1:
Quantity_Color
theColor2:
Quantity_Color
theFillStyle:
Aspect_GradientFillMethod
Returns
void
Set
Default
Computed
Mode
Set
Default
Computed
Mode
(
theMode
:
boolean
)
:
void
Parameters
theMode:
boolean
Returns
void
Set
Default
Lights
Set
Default
Lights
(
)
:
void
Returns
void
Set
Default
Rendering
Params
Set
Default
Rendering
Params
(
theParams
:
Graphic3d_RenderingParams
)
:
void
Parameters
theParams:
Graphic3d_RenderingParams
Returns
void
Set
Default
Shading
Model
Set
Default
Shading
Model
(
theType
:
V3d_TypeOfShadingModel
)
:
void
Parameters
theType:
V3d_TypeOfShadingModel
Returns
void
Set
Default
Type
Of
View
Set
Default
Type
Of
View
(
theType
:
V3d_TypeOfView
)
:
void
Parameters
theType:
V3d_TypeOfView
Returns
void
Set
Default
View
Proj
Set
Default
View
Proj
(
theOrientation
:
V3d_TypeOfOrientation
)
:
void
Parameters
theOrientation:
V3d_TypeOfOrientation
Returns
void
Set
Default
View
Size
Set
Default
View
Size
(
theSize
:
number
)
:
void
Parameters
theSize:
number
Returns
void
Set
Default
Visualization
Set
Default
Visualization
(
theType
:
V3d_TypeOfVisualization
)
:
void
Parameters
theType:
V3d_TypeOfVisualization
Returns
void
Set
Grid
Echo_
1
Set
Grid
Echo_
1
(
showGrid
:
boolean
)
:
void
Parameters
showGrid:
boolean
Returns
void
Set
Grid
Echo_
2
Set
Grid
Echo_
2
(
aMarker
:
Handle_Graphic3d_AspectMarker3d
)
:
void
Parameters
aMarker:
Handle_Graphic3d_AspectMarker3d
Returns
void
Set
Light
Off_
1
Set
Light
Off_
1
(
theLight
:
any
)
:
void
Parameters
theLight:
any
Returns
void
Set
Light
Off_
2
Set
Light
Off_
2
(
)
:
void
Returns
void
Set
Light
On_
1
Set
Light
On_
1
(
theLight
:
any
)
:
void
Parameters
theLight:
any
Returns
void
Set
Light
On_
2
Set
Light
On_
2
(
)
:
void
Returns
void
Set
Privileged
Plane
Set
Privileged
Plane
(
thePlane
:
gp_Ax3
)
:
void
Parameters
thePlane:
gp_Ax3
Returns
void
Set
Rectangular
Grid
Graphic
Values
Set
Rectangular
Grid
Graphic
Values
(
XSize
:
number
, YSize
:
number
, OffSet
:
number
)
:
void
Parameters
XSize:
number
YSize:
number
OffSet:
number
Returns
void
Set
Rectangular
Grid
Values
Set
Rectangular
Grid
Values
(
XOrigin
:
number
, YOrigin
:
number
, XStep
:
number
, YStep
:
number
, RotationAngle
:
number
)
:
void
Parameters
XOrigin:
number
YOrigin:
number
XStep:
number
YStep:
number
RotationAngle:
number
Returns
void
Set
View
Off_
1
Set
View
Off_
1
(
)
:
void
Returns
void
Set
View
Off_
2
Set
View
Off_
2
(
theView
:
Handle_V3d_View
)
:
void
Parameters
theView:
Handle_V3d_View
Returns
void
Set
View
On_
1
Set
View
On_
1
(
)
:
void
Returns
void
Set
View
On_
2
Set
View
On_
2
(
theView
:
Handle_V3d_View
)
:
void
Parameters
theView:
Handle_V3d_View
Returns
void
SetZLayer
Settings
SetZLayer
Settings
(
theLayerId
:
Graphic3d_ZLayerId
, theSettings
:
Graphic3d_ZLayerSettings
)
:
void
Parameters
theLayerId:
Graphic3d_ZLayerId
theSettings:
Graphic3d_ZLayerSettings
Returns
void
Show
Grid
Echo
Show
Grid
Echo
(
theView
:
Handle_V3d_View
, thePoint
:
Graphic3d_Vertex
)
:
void
Parameters
theView:
Handle_V3d_View
thePoint:
Graphic3d_Vertex
Returns
void
Structure
Manager
Structure
Manager
(
)
:
Handle_Graphic3d_StructureManager
Returns
Handle_Graphic3d_StructureManager
This
This
(
)
:
Standard_Transient
Returns
Standard_Transient
Un
Highlight
Un
Highlight
(
)
:
void
Returns
void
Update
Update
(
)
:
void
Returns
void
Update
Lights
Update
Lights
(
)
:
void
Returns
void
ZLayer
Settings
ZLayer
Settings
(
theLayerId
:
Graphic3d_ZLayerId
)
:
Graphic3d_ZLayerSettings
Parameters
theLayerId:
Graphic3d_ZLayerId
Returns
Graphic3d_ZLayerSettings
delete
delete
(
)
:
void
Returns
void
Static
get_
type_
descriptor
get_
type_
descriptor
(
)
:
Handle_Standard_Type
Returns
Handle_Standard_Type
Static
get_
type_
name
get_
type_
name
(
)
:
number
Returns
number
Exports
V3d_
Viewer
constructor
Activate
Grid
Active
Light
Active
Light
Iterator
Active
Lights
Active
View
Active
View
Iterator
Active
Views
Add
Light
AddZLayer
Circular
Grid
Graphic
Values
Circular
Grid
Values
Computed
Mode
Create
View
Deactivate
Grid
Decrement
Ref
Counter
Default
Background
Color
Default
Bg
Gradient
Colors
Default
Computed
Mode
Default
Rendering
Params
Default
Shading
Model
Default
Type
Of
View
Default
View
Proj
Default
View
Size
Default
Visualization
Defined
Light
Defined
Light
Iterator
Defined
Lights
Defined
View
Defined
View
Iterator
Defined
Views
Del
Light
Delete
Display
Privileged
Plane
Driver
Dump
Json
Dynamic
Type
Erase
Get
AllZLayers
Get
Gradient
Background
Get
Ref
Count
Grid
Draw
Mode
Grid
Echo
Grid
Type
Grid_
1
Grid_
2
Hide
Grid
Echo
If
More
Views
Increment
Ref
Counter
Init
Active
Lights
Init
Active
Views
Init
Defined
Lights
Init
Defined
Views
Insert
Layer
After
Insert
Layer
Before
Invalidate
Is
Active
Is
Global
Light
Is
Grid
Active
Is
Instance_
1
Is
Instance_
2
Is
Kind_
1
Is
Kind_
2
Last
Active
View
More
Active
Lights
More
Active
Views
More
Defined
Lights
More
Defined
Views
Next
Active
Lights
Next
Active
Views
Next
Defined
Lights
Next
Defined
Views
Privileged
Plane
Rectangular
Grid
Graphic
Values
Rectangular
Grid
Values
Redraw
Redraw
Immediate
Remove
RemoveZLayer
Set
Circular
Grid
Graphic
Values
Set
Circular
Grid
Values
Set
Computed
Mode
Set
Default
Background
Color
Set
Default
Bg
Gradient
Colors
Set
Default
Computed
Mode
Set
Default
Lights
Set
Default
Rendering
Params
Set
Default
Shading
Model
Set
Default
Type
Of
View
Set
Default
View
Proj
Set
Default
View
Size
Set
Default
Visualization
Set
Grid
Echo_
1
Set
Grid
Echo_
2
Set
Light
Off_
1
Set
Light
Off_
2
Set
Light
On_
1
Set
Light
On_
2
Set
Privileged
Plane
Set
Rectangular
Grid
Graphic
Values
Set
Rectangular
Grid
Values
Set
View
Off_
1
Set
View
Off_
2
Set
View
On_
1
Set
View
On_
2
SetZLayer
Settings
Show
Grid
Echo
Structure
Manager
This
Un
Highlight
Update
Update
Lights
ZLayer
Settings
delete
get_
type_
descriptor
get_
type_
name
Generated using
TypeDoc