Version: 9.12.0
GEOM::GEOM_Object Interface Reference

Interface of geometric object.

import"GEOM_Gen.idl";

Inheritance diagram for GEOM::GEOM_Object:
Inheritance graph

Public Member Functions

shape_type GetShapeType ()
 Get a shape_type of the object value. More...
 
shape_type GetTopologyType ()
 Get the topology type of the object value. More...
 
shape_type GetMinShapeType ()
 Get a minimal type of the top-level shapes contained in the object. More...
 
shape_type GetMaxShapeType ()
 Get a maximal type of the top-level shapes contained in the object. More...
 
string GetSubShapeName (in long subID)
 Returns a name of a sub-shape if the sub-shape is published in the study. More...
 
void SetColor (in SALOMEDS::Color theColor)
 Set color of the object. More...
 
SALOMEDS::Color GetColor ()
 
void SetAutoColor (in boolean theAutoColor)
 
boolean GetAutoColor ()
 Get flag of object's auto color mode. More...
 
void SetMarkerStd (in marker_type theType, in marker_size theSize)
 Set standard point marker for the object. More...
 
void SetMarkerTexture (in long theTextureId)
 Set custom point marker for the object. More...
 
marker_type GetMarkerType ()
 Get type of the point marker assigned to the object. More...
 
marker_size GetMarkerSize ()
 Get size of the point marker assigned to the object. More...
 
long GetMarkerTexture ()
 Get texture idenifier of the point marker assigned to the object. More...
 
long long getShape ()
 Get the TopoDS_Shape, for colocated case only. More...
 
SALOMEDS::TMPFile GetShapeStream ()
 Get geometric shape of the object as a byte stream in BRep format. More...
 
boolean IsMainShape ()
 
ListOfLong GetSubShapeIndices ()
 
GEOM_Object GetMainShape ()
 
boolean IsParametrical ()
 
- Public Member Functions inherited from GEOM::GEOM_BaseObject
void SetName (in string theName)
 Set name of the object. More...
 
string GetName ()
 Get name of the object associated with this object. More...
 
string GetEntry ()
 Get internal (unique) entry of the object in the GEOM component's data tree. More...
 
long GetType ()
 Get internal type of operation created this object (POINT, BOX, CYLINDER, EXTRUSION...). More...
 
long GetTick ()
 Get value of a modification counter of the object. More...
 
void SetStudyEntry (in string theEntry)
 Set a Study entry where this object was published. More...
 
string GetStudyEntry ()
 Get a Study entry where this object was published. More...
 
ListOfGBO GetDependency ()
 Get a list of all GEOM_Object on which were the arguments when this object was constructed and modified. More...
 
ListOfGBO GetLastDependency ()
 Get a list of GEOM_Object on which the last function that created or modified the object depends. More...
 
boolean IsShape ()
 
boolean IsSame (in GEOM_BaseObject other)
 
void SetParameters (in string theParameters)
 
string GetParameters ()
 Return list of notebook variables used for object creation separated by ":" symbol. More...
 
CreationInformationSeq GetCreationInformation ()
 Return name of operation and values of parameters used for object creation. More...
 
GEOM_Gen GetGen ()
 Return the engine creating this object. More...
 

Member Function Documentation

◆ GetAutoColor()

bool GEOM_Object::GetAutoColor ( )

GetAutoColor

References AUTO_COLOR_LABEL, and Handle().

◆ GetColor()

GEOM_Object::Color GEOM_Object::GetColor ( )

Get color of the object.

GetColor

References GEOM::Color, COLOR_LABEL, and Handle().

◆ GetMainShape()

GEOM_Object GEOM::GEOM_Object::GetMainShape ( )

◆ GetMarkerSize()

double GEOM_Object::GetMarkerSize ( )
Returns
current marker relative size (MS_NONE if no marker is set)

GetMarkerSize

References Handle(), MARKER_LABEL, and MARKER_LABEL_SIZE.

◆ GetMarkerTexture()

int GEOM_Object::GetMarkerTexture ( )
Returns
marker texture ID (0 if no marker set)

GetMarkerTexture

References Handle(), MARKER_LABEL, and MARKER_LABEL_ID.

◆ GetMarkerType()

Aspect_TypeOfMarker GEOM_Object::GetMarkerType ( )
Returns
current marker type (MT_NONE if no marker is set)

GetMarkerType

References Handle(), MARKER_LABEL, and MARKER_LABEL_TYPE.

◆ GetMaxShapeType()

shape_type GEOM::GEOM_Object::GetMaxShapeType ( )

This function is useful for the compounds only; for simple shapes it exactly the same value as GetShapeType(). Note, that compounds are processed recursively.

See also
GetShapeType(), GetTopologyType(), GetMinShapeType()

◆ GetMinShapeType()

shape_type GEOM::GEOM_Object::GetMinShapeType ( )

This function is useful for the compounds only; for simple shapes it exactly the same value as GetShapeType(). Note, that compounds are processed recursively.

See also
GetShapeType(), GetTopologyType(), GetMaxShapeType()

◆ getShape()

long long GEOM::GEOM_Object::getShape ( )

◆ GetShapeStream()

SALOMEDS::TMPFile GEOM::GEOM_Object::GetShapeStream ( )
Note
GEOM_IInsertOperations::RestoreShape() method can be used to restore shape from a BRep stream.

◆ GetShapeType()

shape_type GEOM::GEOM_Object::GetShapeType ( )

◆ GetSubShapeIndices()

ListOfLong GEOM::GEOM_Object::GetSubShapeIndices ( )

◆ GetSubShapeName()

string GEOM::GEOM_Object::GetSubShapeName ( in long  subID)
Parameters
subID- sub-shape ID
Returns
string - the found name or an empty string if the sub-shape does not exits or is not published in the study
Note
Only sub-shapes directly retrieved (using e.g. ExtractSubShapes() or via group creation) can be found. Also, as sub-shape can be published in the study many times, only the first found name is returned.

◆ GetTopologyType()

shape_type GEOM::GEOM_Object::GetTopologyType ( )

In contrast to the shape type, this function returns type of the most top-level sub-shape of the COMPOUND or COMPSOLID, if there is only one sub-shape there.

See also
GetShapeType()

◆ IsMainShape()

bool GEOM_Object::IsMainShape ( )

IsSubShape

References Handle().

◆ IsParametrical()

boolean GEOM::GEOM_Object::IsParametrical ( )

◆ SetAutoColor()

void GEOM_Object::SetAutoColor ( in boolean  theAutoColor)

Toggle auto color mode on the object.

Parameters
theAutoColoris a flag which toggles auto color mode.

SetAutoColor

References AUTO_COLOR_LABEL.

◆ SetColor()

void GEOM_Object::SetColor ( in SALOMEDS::Color  theColor)
Parameters
theColoris a color of the object.

SetColor

References COLOR_LABEL, and Handle().

◆ SetMarkerStd()

void GEOM_Object::SetMarkerStd ( in marker_type  theType,
in marker_size  theSize 
)
Parameters
theTypestandard marker type
theSizemarker relative size

SetMarkerStd

References MARKER_LABEL, MARKER_LABEL_SIZE, and MARKER_LABEL_TYPE.

◆ SetMarkerTexture()

void GEOM_Object::SetMarkerTexture ( in long  theTextureId)

The texture can be added by LoadTexture() or AddTexture() functions.

Parameters
theTextureIdtexture ID

SetMarkerTexture

References MARKER_LABEL, MARKER_LABEL_ID, and MARKER_LABEL_TYPE.


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