Interface of geometric object. More...

import "GEOM_Gen.idl";

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 ()

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	GetStudyID ()
	Get ID of study, where the object is created. 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...

Detailed Description

Interface of geometric object.

Member Function Documentation

shape_type GetShapeType ( )

Get a shape_type of the object value.

shape_type GetTopologyType ( )

Get the topology type of the object value.

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()

shape_type GetMinShapeType ( )

Get a minimal type of the top-level shapes contained in the object.

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

See Also: GetShapeType(), GetTopologyType(), GetMaxShapeType()

shape_type GetMaxShapeType ( )

Get a maximal type of the top-level shapes contained in the object.

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

See Also: GetShapeType(), GetTopologyType(), GetMinShapeType()

string GetSubShapeName ( in long subID )

Returns a name of a sub-shape if the sub-shape is published in the study.

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.

void SetColor ( in SALOMEDS::Color theColor )

Set color of the object.

Parameters

theColor is a color of the object.

SALOMEDS::Color GetColor ( )

Get color of the object.

void SetAutoColor ( in boolean theAutoColor )

Toggle auto color mode on the object.

Parameters

theAutoColor is a flag which toggles auto color mode.

boolean GetAutoColor ( )

Get flag of object's auto color mode.

void SetMarkerStd	(	in marker_type	theType,
		in marker_size	theSize
	)

Set standard point marker for the object.

Parameters

theType	standard marker type
theSize	marker relative size

void SetMarkerTexture ( in long theTextureId )

Set custom point marker for the object.

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

Parameters

theTextureId texture ID

marker_type GetMarkerType ( )

Get type of the point marker assigned to the object.

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

marker_size GetMarkerSize ( )

Get size of the point marker assigned to the object.

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

long GetMarkerTexture ( )

Get texture idenifier of the point marker assigned to the object.

Returns: marker texture ID (0 if no marker set)

long long getShape ( )

Get the TopoDS_Shape, for colocated case only.

SALOMEDS::TMPFile GetShapeStream ( )

Get geometric shape of the object as a byte stream in BRep format.

Note: GEOM_IInsertOperations::RestoreShape() method can be used to restore shape from a BRep stream.

boolean IsMainShape ( )

ListOfLong GetSubShapeIndices ( )

GEOM_Object GetMainShape ( )

void SetName ( in string theName )

inherited

Set name of the object.

Parameters

theName is a name which will be associated with this object.

string GetName ( )

inherited

Get name of the object associated with this object.

string GetEntry ( )

inherited

Get internal (unique) entry of the object in the GEOM component's data tree.

Note: This is not an entry of the data object in SALOME study. This is internal function of GEOM component, though it can be used outside it for appropriate reason (e.g. for unique identification of geometry object).

long GetStudyID ( )

inherited

Get ID of study, where the object is created.

long GetType ( )

inherited

Get internal type of operation created this object (POINT, BOX, CYLINDER, EXTRUSION...).

Note: To get topological information on the object, use WhatIs() or KindOfShape() operation.

long GetTick ( )

inherited

Get value of a modification counter of the object.

void SetStudyEntry ( in string theEntry )

inherited

Set a Study entry where this object was published.

string GetStudyEntry ( )

inherited

Get a Study entry where this object was published.

ListOfGBO GetDependency ( )

inherited

Get a list of all GEOM_Object on which were the arguments when this object was constructed and modified.

Note: This method is supposed to be used by GUI only.

ListOfGBO GetLastDependency ( )

inherited

Get a list of GEOM_Object on which the last function that created or modified the object depends.

Note: This method is supposed to be used by GUI only.

boolean IsShape ( )

inherited

boolean IsSame ( in GEOM_BaseObject other )

inherited

void SetParameters ( in string theParameters )

inherited

Set list of parameters

Parameters

theParameters is a string containing the notebook variables separated by ":" symbol, used for object creation

string GetParameters ( )

inherited

Return list of notebook variables used for object creation separated by ":" symbol.

CreationInformationSeq GetCreationInformation ( )

inherited

Return name of operation and values of parameters used for object creation.

Public Member Functions

Detailed Description

Member Function Documentation