Version: 9.12.0
GEOM_Swig Class Reference

#include <libGEOM_Swig.h>

Public Member Functions

GEOMGUI_EXPORT GEOM_Swig (bool updateOB=true)
 Constructor. More...
 
GEOMGUI_EXPORT ~GEOM_Swig ()
 Destructor. More...
 
GEOMGUI_EXPORT void createAndDisplayGO (const char *theEntry, bool theUpdateViewer=true)
 Display the presenation in the currently active view. More...
 
GEOMGUI_EXPORT void createAndDisplayFitAllGO (const char *theEntry)
 Same as createAndDisplayGO, but also fits the active view to the contents. More...
 
GEOMGUI_EXPORT void eraseGO (const char *theEntry, bool theUpdateViewer=true)
 Erase presentation in the currently active viewer. More...
 
GEOMGUI_EXPORT void UpdateViewer ()
 Update active viewer contents. More...
 
GEOMGUI_EXPORT void setDisplayMode (const char *theEntry, int theMode, bool theUpdateViewer=true)
 Set display mode to the presentation. More...
 
GEOMGUI_EXPORT void setVectorsMode (const char *theEntry, bool theOn, bool theUpdateViewer=true)
 Show / hide edges direction vectors for the presentation. More...
 
GEOMGUI_EXPORT void setVerticesMode (const char *theEntry, bool theOn, bool theUpdateViewer=true)
 Show / hide vertices for the presentation. More...
 
GEOMGUI_EXPORT void setNameMode (const char *theEntry, bool theOn, bool theUpdateViewer=true)
 Show / hide name of shape for the presentation. More...
 
GEOMGUI_EXPORT void setColor (const char *theEntry, int theRed, int theGreen, int theBlue, bool theUpdateViewer=true)
 Change color of the presentation. More...
 
GEOMGUI_EXPORT void setTransparency (const char *theEntry, float theTransparency, bool theUpdateViewer=true)
 Set transparency of the presentation. More...
 
GEOMGUI_EXPORT void setIsos (const char *theEntry, int theNbU, int theNbV, bool theUpdateViewer=true)
 Set number of iso-lines to the presentation. More...
 
GEOMGUI_EXPORT void setDeflection (const char *theEntry, float theDeflection, bool theUpdateViewer=true)
 Set deflection coefficient of the presentation. More...
 
GEOMGUI_EXPORT void setMaterial (const char *theEntry, const char *theMaterial, bool theUpdateViewer=true)
 Set material to the presentation. More...
 
GEOMGUI_EXPORT void setMaterialProperty (const char *theEntry, const char *theMaterial, bool theUpdateViewer=true)
 Set material property to the presentation. More...
 
GEOMGUI_EXPORT void initLocalSelection (const char *theEntry, int theMode)
 initialize local subShapes selection on a given shape More...
 
GEOMGUI_EXPORT std::vector< int > getLocalSelection ()
 get local subShapes selection on a given shape More...
 
GEOMGUI_EXPORT void closeLocalSelection ()
 close local subShapes selection on a given shape More...
 
GEOMGUI_EXPORT int getIndexTopology (const char *theSubIOR, const char *theMainIOR)
 Get sub-shape index inside main shape. More...
 
GEOMGUI_EXPORT const char * getShapeTypeString (const char *theIOR)
 Get shape type name. More...
 
GEOMGUI_EXPORT const char * getShapeTypeIcon (const char *theIOR)
 Get shape's icon ID (specified by its type) More...
 
GEOMGUI_EXPORT bool initGeomGen ()
 Initialize GEOM module's engine. More...
 

Static Public Attributes

static GEOM_Swig_LocalSelectormyLocalSelector = 0
 
static GEOMGUI_OCCSelectormyOCCSelector =0
 

Private Member Functions

void init (bool updateOB)
 Internal initialization. More...
 

Constructor & Destructor Documentation

◆ GEOM_Swig()

GEOM_Swig::GEOM_Swig ( bool  updateOB = true)

References init().

◆ ~GEOM_Swig()

GEOM_Swig::~GEOM_Swig ( )

Member Function Documentation

◆ closeLocalSelection()

void GEOM_Swig::closeLocalSelection ( )

References myLocalSelector.

◆ createAndDisplayFitAllGO()

void GEOM_Swig::createAndDisplayFitAllGO ( const char *  theEntry)
Parameters
theEntrygeometry object's entry
theUpdateViewertrue to update active view's contents

References createAndDisplayGO().

◆ createAndDisplayGO()

void GEOM_Swig::createAndDisplayGO ( const char *  theEntry,
bool  theUpdateViewer = true 
)
Parameters
theEntrygeometry object's entry
theUpdateViewertrue to update active view's contents

References GEOM_Displayer::Display(), and Handle().

◆ eraseGO()

void GEOM_Swig::eraseGO ( const char *  theEntry,
bool  theUpdateViewer = true 
)
Parameters
theEntrygeometry object's entry
theUpdateViewertrue to update active view's contents

References GEOM_Displayer::Erase(), and Handle().

◆ getIndexTopology()

int GEOM_Swig::getIndexTopology ( const char *  theSubIOR,
const char *  theMainIOR 
)
Parameters
theSubIORsub-shape geometry object's IOR
theMainIORmain shape geometry object's IOR
Returns
sub-shape index (-1 in case of error)

References GeometryGUI::GetGeomGen().

◆ getLocalSelection()

std::vector< int > GEOM_Swig::getLocalSelection ( )
Returns
a list of selected subShapes indexes

References GEOM_Swig_LocalSelector::getSelection(), and myLocalSelector.

◆ getShapeTypeIcon()

const char * GEOM_Swig::getShapeTypeIcon ( const char *  theIOR)
Parameters
theIORgeometry object's IOR
Returns
icon ID ("None" in case of error)

References GEOM::COMPOUND, and GEOM::SHAPE.

◆ getShapeTypeString()

const char * GEOM_Swig::getShapeTypeString ( const char *  theIOR)
Parameters
theIORgeometry object's IOR
Returns
shape type name ("Shape of unknown type" in case of error)

References GeometryGUI::GetGeomGen().

◆ init()

void GEOM_Swig::init ( bool  updateOB)
private

◆ initGeomGen()

bool GEOM_Swig::initGeomGen ( )
Returns
true if initialization succeeds or false otherwise

◆ initLocalSelection()

void GEOM_Swig::initLocalSelection ( const char *  theEntry,
int  theMode 
)
Parameters
theEntrygeometry object's entry
theModefrom enum TopAbs_ShapeEnum

References myLocalSelector, and myOCCSelector.

◆ setColor()

void GEOM_Swig::setColor ( const char *  theEntry,
int  theRed,
int  theGreen,
int  theBlue,
bool  theUpdateViewer = true 
)
Parameters
theEntrygeometry object's entry
theRedred component of the component (0-255)
theGreengreen component of the component (0-255)
theBlueblue component of the component (0-255)
theUpdateViewertrue to update active view's contents

References GEOM::Color, and GEOM::propertyName().

◆ setDeflection()

void GEOM_Swig::setDeflection ( const char *  theEntry,
float  theDeflection,
bool  theUpdateViewer = true 
)
Parameters
theEntrygeometry object's entry
theDeflectiondeflection coefficient (floating point value)
theUpdateViewertrue to update active view's contents

References GEOM::Deflection, and GEOM::propertyName().

◆ setDisplayMode()

void GEOM_Swig::setDisplayMode ( const char *  theEntry,
int  theMode,
bool  theUpdateViewer = true 
)
Parameters
theEntrygeometry object's entry
theModedisplay mode: 0 - wireframe, 1 - shading, 2 - shading+edges, 3-textured
theUpdateViewertrue to update active view's contents

References GEOM::DisplayMode, and GEOM::propertyName().

◆ setIsos()

void GEOM_Swig::setIsos ( const char *  theEntry,
int  theNbU,
int  theNbV,
bool  theUpdateViewer = true 
)
Parameters
theEntrygeometry object's entry
theNbUnumber of iso-lines along U axis (integer value >= 0)
theNbVnumber of iso-lines along V axis (integer value >= 0)
theUpdateViewertrue to update active view's contents

References GEOM::NbIsos, GEOM::propertyName(), and GEOM::subSectionSeparator().

◆ setMaterial()

void GEOM_Swig::setMaterial ( const char *  theEntry,
const char *  theMaterial,
bool  theUpdateViewer = true 
)
Parameters
theEntrygeometry object's entry
theMaterialmaterial name (string)
theUpdateViewertrue to update active view's contents

References Material_Model::fromResources(), GEOM::Material, GEOM::propertyName(), and Material_Model::toProperties().

◆ setMaterialProperty()

void GEOM_Swig::setMaterialProperty ( const char *  theEntry,
const char *  theMaterial,
bool  theUpdateViewer = true 
)
Parameters
theEntrygeometry object's entry
theMaterialmaterial property string
theUpdateViewertrue to update active view's contents

References GEOM::Material, and GEOM::propertyName().

◆ setNameMode()

void GEOM_Swig::setNameMode ( const char *  theEntry,
bool  theOn,
bool  theUpdateViewer = true 
)
Parameters
theEntrygeometry object's entry
theOntrue to show name or false otherwise
theUpdateViewertrue to update active view's contents

References GEOM::propertyName(), and GEOM::ShowName.

◆ setTransparency()

void GEOM_Swig::setTransparency ( const char *  theEntry,
float  theTransparency,
bool  theUpdateViewer = true 
)
Parameters
theEntrygeometry object's entry
theTransparencytransparency (floating point value between 0 and 1)
theUpdateViewertrue to update active view's contents

References GEOM::propertyName(), and GEOM::Transparency.

◆ setVectorsMode()

void GEOM_Swig::setVectorsMode ( const char *  theEntry,
bool  theOn,
bool  theUpdateViewer = true 
)
Parameters
theEntrygeometry object's entry
theOntrue to show edges direction vectors or false otherwise
theUpdateViewertrue to update active view's contents

References GEOM::EdgesDirection, and GEOM::propertyName().

◆ setVerticesMode()

void GEOM_Swig::setVerticesMode ( const char *  theEntry,
bool  theOn,
bool  theUpdateViewer = true 
)
Parameters
theEntrygeometry object's entry
theOntrue to show vertices or false otherwise
theUpdateViewertrue to update active view's contents

References GEOM::propertyName(), and GEOM::Vertices.

◆ UpdateViewer()

void GEOM_Swig::UpdateViewer ( )

Member Data Documentation

◆ myLocalSelector

GEOM_Swig_LocalSelector * GEOM_Swig::myLocalSelector = 0
static

◆ myOCCSelector

GEOMGUI_OCCSelector * GEOM_Swig::myOCCSelector =0
static

The documentation for this class was generated from the following files: