Public Member Functions | List of all members
GeomDocument Class Reference

GeomDocument Class
The commands in the GeomDocument class are described below.
. More...

Public Member Functions

void ClearAllJcfRegionIds ()
 Deletes the inheritance information from JCF.
 
void CompressMesh ()
 Removes unused nodes from current mesh. When this command is executed, the operation history is cleared.
 
ReferenceObjectCreateReferenceFromElementEdge (String &id)
 Specifies an element edge ID and creates ReferenceObject. More...
 
ReferenceObjectCreateReferenceFromElementFace (String &id)
 Specifies an element face ID and creates ReferenceObject. More...
 
ReferenceObjectCreateReferenceFromIdentifier (String &id)
 Specifies an ID and creates ReferenceObject. More...
 
ReferenceObjectCreateReferenceFromItem (ItemObject *object)
 Creates ReferenceObject from ItemObject. More...
 
ReferenceObjectCreateReferenceFromNode (String &id)
 Specifies a node ID and creates ReferenceObject. More...
 
void ExportData (String &filename, bool forceUseKeepMeshId=false)
 Exports the file by specifying the path and extension (*.sat, *.sab, *.dxf, *.jmdl). More...
 
void ExportGeometryAndMesh (String &filename, bool forceUseKeepMeshId=false)
 Exports the geometry and mesh to JCF file. More...
 
String FullPath ()
 Returns the full path of the document. More...
 
AssemblyGetAssembly ()
 Returns the root assembly. More...
 
AssemblyManagerGetAssemblyManager ()
 Returns AssemblyManager. More...
 
BuildMessageGetBuildMessage (int index)
 Returns the messages in the model creation. More...
 
DesignTableGetDesignTable ()
 Returns DesignTable. More...
 
DirectCreationManagerGetDirectCreationManager ()
 Returns DirectCreationManager. More...
 
MeasureManagerGetMeasureManager ()
 Returns MeasureManager. More...
 
MeshManagerGetMeshManager ()
 Returns MeshManager. More...
 
PartManagerGetPartManager ()
 Obtains PartManager. More...
 
GeomSelectionGetSelection ()
 Returns the selected object, such as part, face, edge, and vertex. More...
 
SketchManagerGetSketchManager ()
 Returns SketchManager object that provides commands (such as trimming or moving part) for editing basic shape. More...
 
VolumeCalculationManagerGetVolumeCalculationManager ()
 Returns VolumeCalculationManager. More...
 
bool HasErrorMessage ()
 Returns true as a return value if there is an error message. More...
 
bool HasIntersection ()
 Checks interference among solids (or regions). More...
 
bool HasIntersectionGeomAndMesh ()
 Checks interference in solids and mesh blocks (or regions and mesh blocks). More...
 
bool HasWarningMessage ()
 Returns true as a return value if there is a warning message. More...
 
int NumBuildMessages ()
 Returns the number of messages in the model creation. More...
 
void RenumberElementId ()
 Renumbers the ID of elements.
 
void RenumberNodeId ()
 Renumbers the ID of nodes.
 
void Save ()
 Saves data in the user folder.
 
void SaveAs (String &filename)
 Saves data by specifying the file path. More...
 
void SaveModel (bool save_jproj)
 Saves assembly created with Geometry Editor. More...
 
void SetBlockUpdate (bool flag)
 Specifies whether or not to stop running an automatic update of the screen display. More...
 
void SetFileSaveConfirmation (bool flag)
 Specifies whether or not to display or hide the dialog confirming whether or not to save a file after the Geometry Editor has ended. More...
 
void UpdateModel (bool save_jproj, bool replace)
 Updates model created with Geometry Editor. More...
 
void UpdateView ()
 Runs the automatic update of the screen display manually if the automatic update is not running.
 

Detailed Description

GeomDocument Class
The commands in the GeomDocument class are described below.
.

The GeomDocument class includes the commands for the following operation.

Member Function Documentation

ReferenceObject * GeomDocument::CreateReferenceFromElementEdge ( String &  id)

Specifies an element edge ID and creates ReferenceObject.

Parameters
idElement edge ID of the object to reference
Returns
ReferenceObject object
ReferenceObject * GeomDocument::CreateReferenceFromElementFace ( String &  id)

Specifies an element face ID and creates ReferenceObject.

Parameters
idElement face ID of the object to reference
Returns
ReferenceObject object
ReferenceObject * GeomDocument::CreateReferenceFromIdentifier ( String &  id)

Specifies an ID and creates ReferenceObject.

Parameters
idID of the object to reference
Returns
ReferenceObject object
ReferenceObject * GeomDocument::CreateReferenceFromItem ( ItemObject object)

Creates ReferenceObject from ItemObject.

Parameters
objectItemObject object
Returns
ReferenceObject object
ReferenceObject * GeomDocument::CreateReferenceFromNode ( String &  id)

Specifies a node ID and creates ReferenceObject.

Parameters
idNode ID of the object to reference
Returns
ReferenceObject object
void GeomDocument::ExportData ( String &  filename,
bool  forceUseKeepMeshId = false 
)

Exports the file by specifying the path and extension (*.sat, *.sab, *.dxf, *.jmdl).

Parameters
filenameFile path
void GeomDocument::ExportGeometryAndMesh ( String &  filename,
bool  forceUseKeepMeshId = false 
)

Exports the geometry and mesh to JCF file.

Parameters
filenameFile path
String GeomDocument::FullPath ( )

Returns the full path of the document.

Returns
Document path
Assembly * GeomDocument::GetAssembly ( )

Returns the root assembly.

Returns
Assembly object

The root assembly is the assembly at the top of the treeview in the [Treeview] tab in [Model Manager] in the work plane.

AssemblyManager * GeomDocument::GetAssemblyManager ( )

Returns AssemblyManager.

Returns
AssemblyManager object
BuildMessage * GeomDocument::GetBuildMessage ( int  index)

Returns the messages in the model creation.

Parameters
indexMessage index of the object to reference
Returns
BuildMessage object
DesignTable * GeomDocument::GetDesignTable ( )

Returns DesignTable.

Returns
DesignTable object
DirectCreationManager * GeomDocument::GetDirectCreationManager ( )
MeasureManager * GeomDocument::GetMeasureManager ( )

Returns MeasureManager.

Returns
MeasureManager object
MeshManager * GeomDocument::GetMeshManager ( )

Returns MeshManager.

Returns
MeshManager object
PartManager * GeomDocument::GetPartManager ( )

Obtains PartManager.

Returns
PartManager object
GeomSelection * GeomDocument::GetSelection ( )

Returns the selected object, such as part, face, edge, and vertex.

Returns
Selection object

For more information about the commands in the Selection class, see " GeomSelection ".

SketchManager * GeomDocument::GetSketchManager ( )

Returns SketchManager object that provides commands (such as trimming or moving part) for editing basic shape.

Returns
SketchManager object
VolumeCalculationManager * GeomDocument::GetVolumeCalculationManager ( )

Returns VolumeCalculationManager.

Returns
VolumeCalculationManager object
bool GeomDocument::HasErrorMessage ( )

Returns true as a return value if there is an error message.

Returns
Existence of an error message
bool GeomDocument::HasIntersection ( )

Checks interference among solids (or regions).

Returns
If interference among solids (or regions) is found, True is returned.
bool GeomDocument::HasIntersectionGeomAndMesh ( )

Checks interference in solids and mesh blocks (or regions and mesh blocks).

Returns
If interference is found, True is returned.
bool GeomDocument::HasWarningMessage ( )

Returns true as a return value if there is a warning message.

Returns
Existence of a warning message
int GeomDocument::NumBuildMessages ( )

Returns the number of messages in the model creation.

Returns
Number of BuildMessage
void GeomDocument::SaveAs ( String &  filename)

Saves data by specifying the file path.

Parameters
filenameFile path
void GeomDocument::SaveModel ( bool  save_jproj)

Saves assembly created with Geometry Editor.

Parameters
save_jproj
1/True=on : Project is also saved.
0/False=off : Project is not saved.
Deprecated:
This command is not available on Linux machines. Instead of this command, use the following command:
In the case of "save_jproj" = True,
1 app = designer.GetApplication()
2 geomApp = app.CreateGeometryEditor()
3 
4 app.ImportDataFromGeometryEditor()
5 geomApp.SaveCurrent()
6 app.Save()

In the case of "save_jproj" = False,
1 app = designer.GetApplication()
2 geomApp = app.CreateGeometryEditor()
3 
4 app.ImportDataFromGeometryEditor()
5 geomApp.SaveCurrent()
void GeomDocument::SetBlockUpdate ( bool  flag)

Specifies whether or not to stop running an automatic update of the screen display.

The display speed becomes slower when complicated geometry with multiple shapes, such as vertices and lines, are created.
In this case, the automatic update of the screen display can stop running if necessary.

Parameters
flag
True=on : Stop running the automatic update
False=off : Start running the automatic update

The automatic update must be set to "False" after creating the geometry.

void GeomDocument::SetFileSaveConfirmation ( bool  flag)

Specifies whether or not to display or hide the dialog confirming whether or not to save a file after the Geometry Editor has ended.

Parameters
flag
True=on : Displays dialog confirming whether or not to save a file
False=off : Does not display dialog confirming whether or not to save a file
void GeomDocument::UpdateModel ( bool  save_jproj,
bool  replace 
)

Updates model created with Geometry Editor.

Parameters
save_jproj
1/True=on : Project is also saved.
0/False=off : Project is not saved.
replace
1/True=on : Replace model.
0/False=off : Update model.
Deprecated:
This command is not available on Linux machines. Instead of this command, use the following command:
In the case of "save_jproj" = True and "replace" = True,
1 app = designer.GetApplication()
2 geomApp = app.CreateGeometryEditor()
3 
4 app.GetCurrentModel().ReplaceCadModel()
5 geomApp.SaveCurrent()
6 app.Save()

In the case of "save_jproj" = True and "replace" = False,
1 app = designer.GetApplication()
2 geomApp = app.CreateGeometryEditor()
3 
4 app.GetCurrentModel().UpdateCadModel()
5 geomApp.SaveCurrent()
6 app.Save()

In the case of "save_jproj" = False and "replace" = True,
1 app = designer.GetApplication()
2 geomApp = app.CreateGeometryEditor()
3 
4 app.GetCurrentModel().ReplaceCadModel()
5 geomApp.SaveCurrent()

In the case of "save_jproj" = False and "replace" = False,
1 app = designer.GetApplication()
2 geomApp = app.CreateGeometryEditor()
3 
4 app.GetCurrentModel().UpdateCadModel()
5 geomApp.SaveCurrent()