GEOM.GEOM_IInsertOperations Interface Reference

import "GEOM_Gen.idl";

Inheritance diagram for GEOM.GEOM_IInsertOperations:

Public Member Functions
GEOM_Object	MakeCopy (in GEOM_Object theOriginal)
void	Export (in GEOM_Object theObject, in string theFileName, in string theFormatName)
GEOM_Object	ImportFile (in string theFileName, in string theFormatName)
void	ImportTranslators (out string_array theFormats, out string_array thePatterns)
void	ExportTranslators (out string_array theFormats, out string_array thePatterns)
long	LoadTexture (in string theTextureFile)
long	AddTexture (in long theWidth, in long theHeight, in SALOMEDS::TMPFile theTexture)
SALOMEDS::TMPFile	GetTexture (in long theID, out long theWidth, out long theHeight)
ListOfLong	GetAllTextures ()
boolean	IsDone ()
void	SetErrorCode (in string theErrorID)
string	GetErrorCode ()
long	GetStudyID ()
void	StartOperation ()
void	FinishOperation ()
void	AbortOperation ()

---

Detailed Description

GEOM_IInsertOperations: Interface for shape insert operations (like copy, import).

---

Member Function Documentation

GEOM_Object GEOM.GEOM_IInsertOperations.MakeCopy

(

in GEOM_Object

theOriginal

)

Create a copy of the given object

void GEOM.GEOM_IInsertOperations.Export	(	in GEOM_Object	theObject,
		in string	theFileName,
		in string	theFormatName
	)

Export the given shape into a file with given name.

Parameters:

theObject	Shape to be stored in the file.
theFileName	Name of the file to store the given shape in.
theFormatName	Specify format for the shape storage. Available formats can be obtained with ImportTranslators() method.

GEOM_Object GEOM.GEOM_IInsertOperations.ImportFile	(	in string	theFileName,
		in string	theFormatName
	)

Import a shape from the BRep or IGES or STEP file (depends on given format) with given name.

Parameters:

theFileName	The file, containing the shape.
theFormatName	Specify format for the file reading. Available formats can be obtained with ImportTranslators() method. If format 'IGES_SCALE' is used instead 'IGES' length unit will be set to 'meter' and result model will be scaled.

Returns:

New GEOM_Object, containing the imported shape.

void GEOM.GEOM_IInsertOperations.ImportTranslators	(	out string_array	theFormats,
		out string_array	thePatterns
	)

Get the supported import formats and corresponding patterns for File dialog.

Parameters:

theFormats	Output. List of formats, available for import.
thePatterns	Output. List of file patterns, corresponding to available formats.

Returns:

Returns available formats and patterns through the arguments.

void GEOM.GEOM_IInsertOperations.ExportTranslators	(	out string_array	theFormats,
		out string_array	thePatterns
	)

Get the supported export formats and corresponding patterns for File dialog.

Parameters:

theFormats	Output. List of formats, available for export.
thePatterns	Output. List of file patterns, corresponding to available formats.

Returns:

Returns available formats and patterns through the arguments.

long GEOM.GEOM_IInsertOperations.LoadTexture

(

in string

theTextureFile

)

Load texture from file

Parameters:

theTextureFile

texture file name

Returns:

unique texture identifier

long GEOM.GEOM_IInsertOperations.AddTexture	(	in long	theWidth,
		in long	theHeight,
		in SALOMEDS::TMPFile	theTexture
	)

Add texture to the study

Parameters:

theWidth	texture width in pixels
theHeight	texture height in pixels
theTexture	texture byte array

Returns:

unique texture identifier

SALOMEDS::TMPFile GEOM.GEOM_IInsertOperations.GetTexture	(	in long	theID,
		out long	theWidth,
		out long	theHeight
	)

Get previously loaded texture data

Parameters:

theID	texture identifier
theWidth	texture width in pixels
theHeight	texture height in pixels

Returns:

texture byte array

ListOfLong GEOM.GEOM_IInsertOperations.GetAllTextures

(

)

Get list of all avaiable texture IDs

Returns:

list of all texture IDs avaiable for the current study

boolean GEOM.GEOM_IOperations.IsDone

(

)

[inherited]

To know, if the operation was successfully performed

void GEOM.GEOM_IOperations.SetErrorCode

(

in string

theErrorID

)

[inherited]

Set the operation error code

Parameters:

theErrorID

is a string describing the error occured

Note:

This method is supposed to be used only by interfaces inheriting from IOperations.

string GEOM.GEOM_IOperations.GetErrorCode

(

)

[inherited]

Get the operation error code

long GEOM.GEOM_IOperations.GetStudyID

(

)

[inherited]

Get ID of study, where the operation is defined

void GEOM.GEOM_IOperations.StartOperation

(

)

[inherited]

Opens a new transaction

void GEOM.GEOM_IOperations.FinishOperation

(

)

[inherited]

Closes the previously opened trasaction

void GEOM.GEOM_IOperations.AbortOperation

(

)

[inherited]

Aborts the previously opened transaction