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
XCAFDoc_DocumentTool
Class XCAFDoc_DocumentTool
Hierarchy
TDataStd_GenericEmpty
XCAFDoc_DocumentTool
Index
Constructors
constructor
Methods
Add
Attribute
After
Addition
After
Resume
After
Retrieval
After
Undo
Backup
Copy
Backup_
1
Before
Commit
Transaction
Before
Forget
Before
Removal
Before
Undo
Decrement
Ref
Counter
Delete
Delta
On
Addition
Delta
On
Forget
Delta
On
Modification_
1
Delta
On
Modification_
2
Delta
On
Removal
Delta
On
Resume
Dump
Json
Dynamic
Type
Extended
Dump
Find
Attribute_
1
Forget
Forget
All
Attributes
Forget
Attribute
Get
Ref
Count
ID
Increment
Ref
Counter
Init
Is
Attribute
Is
Backuped
Is
Forgotten
Is
Instance_
1
Is
Instance_
2
Is
Kind_
1
Is
Kind_
2
Is
New
Is
Valid
Label
New
Empty
Paste
References
Restore
SetID_
1
SetID_
2
This
Transaction
Until
Transaction
delete
Check
Clipping
Plane
Tool
Check
Color
Tool
Check
Dim
Tol
Tool
Check
Layer
Tool
Check
Material
Tool
Check
Notes
Tool
Check
Shape
Tool
Check
View
Tool
Check
Vis
Material
Tool
Clipping
Plane
Tool
Clipping
Planes
Label
Color
Tool
Colors
Label
DGTs
Label
Dim
Tol
Tool
Doc
Label
GetID
Get
Length
Unit_
1
Get
Length
Unit_
2
IsXCAFDocument
Layer
Tool
Layers
Label
Material
Tool
Materials
Label
Notes
Label
Notes
Tool
Set
Set
Length
Unit_
1
Set
Length
Unit_
2
Shape
Tool
Shapes
Label
View
Tool
Views
Label
Vis
Material
Label
Vis
Material
Tool
get_
type_
descriptor
get_
type_
name
Constructors
constructor
new XCAFDoc_
Document
Tool
(
)
:
XCAFDoc_DocumentTool
Returns
XCAFDoc_DocumentTool
Methods
Add
Attribute
Add
Attribute
(
other
:
Handle_TDF_Attribute
)
:
void
Parameters
other:
Handle_TDF_Attribute
Returns
void
After
Addition
After
Addition
(
)
:
void
Returns
void
After
Resume
After
Resume
(
)
:
void
Returns
void
After
Retrieval
After
Retrieval
(
forceIt
:
boolean
)
:
boolean
Parameters
forceIt:
boolean
Returns
boolean
After
Undo
After
Undo
(
anAttDelta
:
Handle_TDF_AttributeDelta
, forceIt
:
boolean
)
:
boolean
Parameters
anAttDelta:
Handle_TDF_AttributeDelta
forceIt:
boolean
Returns
boolean
Backup
Copy
Backup
Copy
(
)
:
Handle_TDF_Attribute
Returns
Handle_TDF_Attribute
Backup_
1
Backup_
1
(
)
:
void
Returns
void
Before
Commit
Transaction
Before
Commit
Transaction
(
)
:
void
Returns
void
Before
Forget
Before
Forget
(
)
:
void
Returns
void
Before
Removal
Before
Removal
(
)
:
void
Returns
void
Before
Undo
Before
Undo
(
anAttDelta
:
Handle_TDF_AttributeDelta
, forceIt
:
boolean
)
:
boolean
Parameters
anAttDelta:
Handle_TDF_AttributeDelta
forceIt:
boolean
Returns
boolean
Decrement
Ref
Counter
Decrement
Ref
Counter
(
)
:
Graphic3d_ZLayerId
Returns
Graphic3d_ZLayerId
Delete
Delete
(
)
:
void
Returns
void
Delta
On
Addition
Delta
On
Addition
(
)
:
Handle_TDF_DeltaOnAddition
Returns
Handle_TDF_DeltaOnAddition
Delta
On
Forget
Delta
On
Forget
(
)
:
Handle_TDF_DeltaOnForget
Returns
Handle_TDF_DeltaOnForget
Delta
On
Modification_
1
Delta
On
Modification_
1
(
anOldAttribute
:
Handle_TDF_Attribute
)
:
Handle_TDF_DeltaOnModification
Parameters
anOldAttribute:
Handle_TDF_Attribute
Returns
Handle_TDF_DeltaOnModification
Delta
On
Modification_
2
Delta
On
Modification_
2
(
aDelta
:
Handle_TDF_DeltaOnModification
)
:
void
Parameters
aDelta:
Handle_TDF_DeltaOnModification
Returns
void
Delta
On
Removal
Delta
On
Removal
(
)
:
Handle_TDF_DeltaOnRemoval
Returns
Handle_TDF_DeltaOnRemoval
Delta
On
Resume
Delta
On
Resume
(
)
:
Handle_TDF_DeltaOnResume
Returns
Handle_TDF_DeltaOnResume
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
Extended
Dump
Extended
Dump
(
anOS
:
Standard_OStream
, aFilter
:
TDF_IDFilter
, aMap
:
TDF_AttributeIndexedMap
)
:
void
Parameters
anOS:
Standard_OStream
aFilter:
TDF_IDFilter
aMap:
TDF_AttributeIndexedMap
Returns
void
Find
Attribute_
1
Find
Attribute_
1
(
anID
:
Standard_GUID
, anAttribute
:
Handle_TDF_Attribute
)
:
boolean
Parameters
anID:
Standard_GUID
anAttribute:
Handle_TDF_Attribute
Returns
boolean
Forget
Forget
(
aTransaction
:
Graphic3d_ZLayerId
)
:
void
Parameters
aTransaction:
Graphic3d_ZLayerId
Returns
void
Forget
All
Attributes
Forget
All
Attributes
(
clearChildren
:
boolean
)
:
void
Parameters
clearChildren:
boolean
Returns
void
Forget
Attribute
Forget
Attribute
(
aguid
:
Standard_GUID
)
:
boolean
Parameters
aguid:
Standard_GUID
Returns
boolean
Get
Ref
Count
Get
Ref
Count
(
)
:
Graphic3d_ZLayerId
Returns
Graphic3d_ZLayerId
ID
ID
(
)
:
Standard_GUID
Returns
Standard_GUID
Increment
Ref
Counter
Increment
Ref
Counter
(
)
:
void
Returns
void
Init
Init
(
)
:
void
Returns
void
Is
Attribute
Is
Attribute
(
anID
:
Standard_GUID
)
:
boolean
Parameters
anID:
Standard_GUID
Returns
boolean
Is
Backuped
Is
Backuped
(
)
:
boolean
Returns
boolean
Is
Forgotten
Is
Forgotten
(
)
:
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
Is
New
Is
New
(
)
:
boolean
Returns
boolean
Is
Valid
Is
Valid
(
)
:
boolean
Returns
boolean
Label
Label
(
)
:
TDF_Label
Returns
TDF_Label
New
Empty
New
Empty
(
)
:
Handle_TDF_Attribute
Returns
Handle_TDF_Attribute
Paste
Paste
(
a0
:
Handle_TDF_Attribute
, a1
:
Handle_TDF_RelocationTable
)
:
void
Parameters
a0:
Handle_TDF_Attribute
a1:
Handle_TDF_RelocationTable
Returns
void
References
References
(
aDataSet
:
Handle_TDF_DataSet
)
:
void
Parameters
aDataSet:
Handle_TDF_DataSet
Returns
void
Restore
Restore
(
a0
:
Handle_TDF_Attribute
)
:
void
Parameters
a0:
Handle_TDF_Attribute
Returns
void
SetID_
1
SetID_
1
(
a0
:
Standard_GUID
)
:
void
Parameters
a0:
Standard_GUID
Returns
void
SetID_
2
SetID_
2
(
)
:
void
Returns
void
This
This
(
)
:
Standard_Transient
Returns
Standard_Transient
Transaction
Transaction
(
)
:
Graphic3d_ZLayerId
Returns
Graphic3d_ZLayerId
Until
Transaction
Until
Transaction
(
)
:
Graphic3d_ZLayerId
Returns
Graphic3d_ZLayerId
delete
delete
(
)
:
void
Returns
void
Static
Check
Clipping
Plane
Tool
Check
Clipping
Plane
Tool
(
theAcces
:
TDF_Label
)
:
boolean
Parameters
theAcces:
TDF_Label
Returns
boolean
Static
Check
Color
Tool
Check
Color
Tool
(
theAcces
:
TDF_Label
)
:
boolean
Parameters
theAcces:
TDF_Label
Returns
boolean
Static
Check
Dim
Tol
Tool
Check
Dim
Tol
Tool
(
theAcces
:
TDF_Label
)
:
boolean
Parameters
theAcces:
TDF_Label
Returns
boolean
Static
Check
Layer
Tool
Check
Layer
Tool
(
theAcces
:
TDF_Label
)
:
boolean
Parameters
theAcces:
TDF_Label
Returns
boolean
Static
Check
Material
Tool
Check
Material
Tool
(
theAcces
:
TDF_Label
)
:
boolean
Parameters
theAcces:
TDF_Label
Returns
boolean
Static
Check
Notes
Tool
Check
Notes
Tool
(
theAcces
:
TDF_Label
)
:
boolean
Parameters
theAcces:
TDF_Label
Returns
boolean
Static
Check
Shape
Tool
Check
Shape
Tool
(
theAcces
:
TDF_Label
)
:
boolean
Parameters
theAcces:
TDF_Label
Returns
boolean
Static
Check
View
Tool
Check
View
Tool
(
theAcces
:
TDF_Label
)
:
boolean
Parameters
theAcces:
TDF_Label
Returns
boolean
Static
Check
Vis
Material
Tool
Check
Vis
Material
Tool
(
theAcces
:
TDF_Label
)
:
boolean
Parameters
theAcces:
TDF_Label
Returns
boolean
Static
Clipping
Plane
Tool
Clipping
Plane
Tool
(
acces
:
TDF_Label
)
:
Handle_XCAFDoc_ClippingPlaneTool
Parameters
acces:
TDF_Label
Returns
Handle_XCAFDoc_ClippingPlaneTool
Static
Clipping
Planes
Label
Clipping
Planes
Label
(
acces
:
TDF_Label
)
:
TDF_Label
Parameters
acces:
TDF_Label
Returns
TDF_Label
Static
Color
Tool
Color
Tool
(
acces
:
TDF_Label
)
:
Handle_XCAFDoc_ColorTool
Parameters
acces:
TDF_Label
Returns
Handle_XCAFDoc_ColorTool
Static
Colors
Label
Colors
Label
(
acces
:
TDF_Label
)
:
TDF_Label
Parameters
acces:
TDF_Label
Returns
TDF_Label
Static
DGTs
Label
DGTs
Label
(
acces
:
TDF_Label
)
:
TDF_Label
Parameters
acces:
TDF_Label
Returns
TDF_Label
Static
Dim
Tol
Tool
Dim
Tol
Tool
(
acces
:
TDF_Label
)
:
Handle_XCAFDoc_DimTolTool
Parameters
acces:
TDF_Label
Returns
Handle_XCAFDoc_DimTolTool
Static
Doc
Label
Doc
Label
(
acces
:
TDF_Label
)
:
TDF_Label
Parameters
acces:
TDF_Label
Returns
TDF_Label
Static
GetID
GetID
(
)
:
Standard_GUID
Returns
Standard_GUID
Static
Get
Length
Unit_
1
Get
Length
Unit_
1
(
theDoc
:
Handle_TDocStd_Document
, theResut
:
number
, theBaseUnit
:
UnitsMethods_LengthUnit
)
:
boolean
Parameters
theDoc:
Handle_TDocStd_Document
theResut:
number
theBaseUnit:
UnitsMethods_LengthUnit
Returns
boolean
Static
Get
Length
Unit_
2
Get
Length
Unit_
2
(
theDoc
:
Handle_TDocStd_Document
, theResut
:
number
)
:
boolean
Parameters
theDoc:
Handle_TDocStd_Document
theResut:
number
Returns
boolean
Static
IsXCAFDocument
IsXCAFDocument
(
Doc
:
Handle_TDocStd_Document
)
:
boolean
Parameters
Doc:
Handle_TDocStd_Document
Returns
boolean
Static
Layer
Tool
Layer
Tool
(
acces
:
TDF_Label
)
:
Handle_XCAFDoc_LayerTool
Parameters
acces:
TDF_Label
Returns
Handle_XCAFDoc_LayerTool
Static
Layers
Label
Layers
Label
(
acces
:
TDF_Label
)
:
TDF_Label
Parameters
acces:
TDF_Label
Returns
TDF_Label
Static
Material
Tool
Material
Tool
(
acces
:
TDF_Label
)
:
Handle_XCAFDoc_MaterialTool
Parameters
acces:
TDF_Label
Returns
Handle_XCAFDoc_MaterialTool
Static
Materials
Label
Materials
Label
(
acces
:
TDF_Label
)
:
TDF_Label
Parameters
acces:
TDF_Label
Returns
TDF_Label
Static
Notes
Label
Notes
Label
(
acces
:
TDF_Label
)
:
TDF_Label
Parameters
acces:
TDF_Label
Returns
TDF_Label
Static
Notes
Tool
Notes
Tool
(
acces
:
TDF_Label
)
:
Handle_XCAFDoc_NotesTool
Parameters
acces:
TDF_Label
Returns
Handle_XCAFDoc_NotesTool
Static
Set
Set
(
L
:
TDF_Label
, IsAcces
:
boolean
)
:
Handle_XCAFDoc_DocumentTool
Parameters
L:
TDF_Label
IsAcces:
boolean
Returns
Handle_XCAFDoc_DocumentTool
Static
Set
Length
Unit_
1
Set
Length
Unit_
1
(
theDoc
:
Handle_TDocStd_Document
, theUnitValue
:
number
)
:
void
Parameters
theDoc:
Handle_TDocStd_Document
theUnitValue:
number
Returns
void
Static
Set
Length
Unit_
2
Set
Length
Unit_
2
(
theDoc
:
Handle_TDocStd_Document
, theUnitValue
:
number
, theBaseUnit
:
UnitsMethods_LengthUnit
)
:
void
Parameters
theDoc:
Handle_TDocStd_Document
theUnitValue:
number
theBaseUnit:
UnitsMethods_LengthUnit
Returns
void
Static
Shape
Tool
Shape
Tool
(
acces
:
TDF_Label
)
:
Handle_XCAFDoc_ShapeTool
Parameters
acces:
TDF_Label
Returns
Handle_XCAFDoc_ShapeTool
Static
Shapes
Label
Shapes
Label
(
acces
:
TDF_Label
)
:
TDF_Label
Parameters
acces:
TDF_Label
Returns
TDF_Label
Static
View
Tool
View
Tool
(
acces
:
TDF_Label
)
:
Handle_XCAFDoc_ViewTool
Parameters
acces:
TDF_Label
Returns
Handle_XCAFDoc_ViewTool
Static
Views
Label
Views
Label
(
acces
:
TDF_Label
)
:
TDF_Label
Parameters
acces:
TDF_Label
Returns
TDF_Label
Static
Vis
Material
Label
Vis
Material
Label
(
theLabel
:
TDF_Label
)
:
TDF_Label
Parameters
theLabel:
TDF_Label
Returns
TDF_Label
Static
Vis
Material
Tool
Vis
Material
Tool
(
theLabel
:
TDF_Label
)
:
Handle_XCAFDoc_VisMaterialTool
Parameters
theLabel:
TDF_Label
Returns
Handle_XCAFDoc_VisMaterialTool
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
XCAFDoc_
Document
Tool
constructor
Add
Attribute
After
Addition
After
Resume
After
Retrieval
After
Undo
Backup
Copy
Backup_
1
Before
Commit
Transaction
Before
Forget
Before
Removal
Before
Undo
Decrement
Ref
Counter
Delete
Delta
On
Addition
Delta
On
Forget
Delta
On
Modification_
1
Delta
On
Modification_
2
Delta
On
Removal
Delta
On
Resume
Dump
Json
Dynamic
Type
Extended
Dump
Find
Attribute_
1
Forget
Forget
All
Attributes
Forget
Attribute
Get
Ref
Count
ID
Increment
Ref
Counter
Init
Is
Attribute
Is
Backuped
Is
Forgotten
Is
Instance_
1
Is
Instance_
2
Is
Kind_
1
Is
Kind_
2
Is
New
Is
Valid
Label
New
Empty
Paste
References
Restore
SetID_
1
SetID_
2
This
Transaction
Until
Transaction
delete
Check
Clipping
Plane
Tool
Check
Color
Tool
Check
Dim
Tol
Tool
Check
Layer
Tool
Check
Material
Tool
Check
Notes
Tool
Check
Shape
Tool
Check
View
Tool
Check
Vis
Material
Tool
Clipping
Plane
Tool
Clipping
Planes
Label
Color
Tool
Colors
Label
DGTs
Label
Dim
Tol
Tool
Doc
Label
GetID
Get
Length
Unit_
1
Get
Length
Unit_
2
IsXCAFDocument
Layer
Tool
Layers
Label
Material
Tool
Materials
Label
Notes
Label
Notes
Tool
Set
Set
Length
Unit_
1
Set
Length
Unit_
2
Shape
Tool
Shapes
Label
View
Tool
Views
Label
Vis
Material
Label
Vis
Material
Tool
get_
type_
descriptor
get_
type_
name
Generated using
TypeDoc