GEOM::GEOM_Object Interface Reference

Interface of geometric object. More...

import "GEOM_Gen.idl";

Public Member Functions
string	GetEntry ()
	Get an entry of the object in GEOM component.
long	GetStudyID ()
	Get ID of study, where the object is created.
long	GetType ()
	Get internal type of the object (POINT, BOX, CYLINDER, EXTRUSION...).
shape_type	GetShapeType ()
	Get a shape_type of the object value.
shape_type	GetTopologyType ()
	Get the topology type of the object value.
shape_type	GetMinShapeType ()
	Get a minimal type of the top-level shapes contained in the object.
shape_type	GetMaxShapeType ()
	Get a maximal type of the top-level shapes contained in the object.
void	SetName (in string theName)
	Set name of the object.
string	GetName ()
	Get name of the object associated with this object.
void	SetColor (in SALOMEDS::Color theColor)
	Set color of the object.
SALOMEDS::Color	GetColor ()
void	SetAutoColor (in boolean theAutoColor)
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.
void	SetMarkerTexture (in long theTextureId)
	Set custom point marker for the object.
marker_type	GetMarkerType ()
	Get type of the point marker assigned to the object.
marker_size	GetMarkerSize ()
	Get size of the point marker assigned to the object.
long	GetMarkerTexture ()
	Get texture idenifier of the point marker assigned to the object.
void	SetStudyEntry (in string theEntry)
	Set a Study entry where this object was published.
string	GetStudyEntry ()
	Get a Study entry where this object was published.
ListOfGO	GetDependency ()
	Get a list of all GEOM_Object on which were the arguments when this object was constructed and modified.
ListOfGO	GetLastDependency ()
	Get a list of GEOM_Object on which the last function that created or modified the object depends.
long long	getShape ()
	Get the TopoDS_Shape, for colocated case only.
SALOMEDS::TMPFile	GetShapeStream ()
	Get geometric shape of the object as a byte stream.
boolean	IsMainShape ()
ListOfLong	GetSubShapeIndices ()
GEOM_Object	GetMainShape ()
boolean	IsShape ()
boolean	IsSame (in GEOM_Object other)
void	SetParameters (in string theParameters)
string	GetParameters ()
	Return list of notebook variables used for object creation separated by ":" symbol.

Detailed Description

Interface of geometric object.

Member Function Documentation

string GEOM::GEOM_Object::GetEntry

(

)

Get an entry of the object in GEOM component.

long GEOM::GEOM_Object::GetStudyID

(

)

Get ID of study, where the object is created.

long GEOM::GEOM_Object::GetType

(

)

Get internal type of the object (POINT, BOX, CYLINDER, EXTRUSION...).

shape_type GEOM::GEOM_Object::GetShapeType

(

)

Get a shape_type of the object value.

shape_type GEOM::GEOM_Object::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 GEOM::GEOM_Object::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 GEOM::GEOM_Object::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()

void GEOM::GEOM_Object::SetName

(

in string

theName

)

Set name of the object.

Parameters

theName

is a name which will be associated with this object.

string GEOM::GEOM_Object::GetName

(

)

Get name of the object associated with this object.

void GEOM::GEOM_Object::SetColor

(

in SALOMEDS::Color

theColor

)

Set color of the object.

Parameters

theColor

is a color of the object.

SALOMEDS::Color GEOM::GEOM_Object::GetColor

(

)

Get color of the object.

void GEOM::GEOM_Object::SetAutoColor

(

in boolean

theAutoColor

)

Toggle auto color mode on the object.

Parameters

theAutoColor

is a flag which toggles auto color mode.

boolean GEOM::GEOM_Object::GetAutoColor

(

)

Get flag of object's auto color mode.

void GEOM::GEOM_Object::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 GEOM::GEOM_Object::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 GEOM::GEOM_Object::GetMarkerType

(

)

Get type of the point marker assigned to the object.

Returns

current marker type (MT_NONE if no marker is set)

marker_size GEOM::GEOM_Object::GetMarkerSize

(

)

Get size of the point marker assigned to the object.

Returns

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

long GEOM::GEOM_Object::GetMarkerTexture

(

)

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

Returns

marker texture ID (0 if no marker set)

void GEOM::GEOM_Object::SetStudyEntry

(

in string

theEntry

)

Set a Study entry where this object was published.

string GEOM::GEOM_Object::GetStudyEntry

(

)

Get a Study entry where this object was published.

ListOfGO GEOM::GEOM_Object::GetDependency

(

)

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.

ListOfGO GEOM::GEOM_Object::GetLastDependency

(

)

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.

long long GEOM::GEOM_Object::getShape

(

)

Get the TopoDS_Shape, for colocated case only.

SALOMEDS::TMPFile GEOM::GEOM_Object::GetShapeStream

(

)

Get geometric shape of the object as a byte stream.

boolean GEOM::GEOM_Object::IsMainShape

(

)

ListOfLong GEOM::GEOM_Object::GetSubShapeIndices

(

)

GEOM_Object GEOM::GEOM_Object::GetMainShape

(

)

boolean GEOM::GEOM_Object::IsShape

(

)

boolean GEOM::GEOM_Object::IsSame

(

in GEOM_Object

other

)

void GEOM::GEOM_Object::SetParameters

(

in string

theParameters

)

Set list of parameters

Parameters

theParameters

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

string GEOM::GEOM_Object::GetParameters

(

)

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