# OCC.IGESCAFControl module

class `IGESCAFControl_Reader`(*args)

  Bases: `OCC.IGESControl.IGESControl_Reader`

  - Creates a reader with an empty IGES model and sets ColorMode, LayerMode and NameMode to Standard_True.

  Return type: | None

  - Creates a reader tool and attaches it to an already existing Session Clears the session if it was not yet set for IGES

  Parameters: | WS (Handle_XSControl_WorkSession &) – scratch (bool) – default value is Standard_True
  Return type: | None

  `GetColorMode`()

    Return type: | bool

  `GetLayerMode`()

    Return type: | bool

  `GetNameMode`()

    Return type: | bool

  `Perform`()

    Parameters: | filename (TCollection_AsciiString &) – doc (Handle_TDocStd_Document &) –
    Return type: | bool

    - Translate IGES file given by filename into the document Return True if succeeded, and False in case of fail

    Parameters: | filename (char *) – doc (Handle_TDocStd_Document &) –
    Return type: | bool

  `SetColorMode`()
    - Set ColorMode for indicate read Colors or not.

    Parameters: | colormode (bool) –
    Return type: | None

  `SetLayerMode`()
    - Set LayerMode for indicate read Layers or not.

    Parameters: | layermode (bool) –
    Return type: | None

  `SetNameMode`()
    - Set NameMode for indicate read Name or not.

    Parameters: | namemode (bool) –
    Return type: | None

  `Transfer`()
    - Translates currently loaded IGES file into the document Returns True if succeeded, and False in case of fail

    Parameters: | doc (Handle_TDocStd_Document &) –
    Return type: | bool

  `thisown`

    The membership flag

class `IGESCAFControl_Writer`(*args)

  Bases: `OCC.IGESControl.IGESControl_Writer`

  - Creates a writer with an empty IGES model and sets ColorMode, LayerMode and NameMode to Standard_True.

  Return type: | None

  - Creates a reader tool and attaches it to an already existing Session Clears the session if it was not yet set for IGES

  Parameters: | WS (Handle_XSControl_WorkSession &) – scratch (bool) – default value is Standard_True
  Return type: | None

  `GetColorMode`()

    Return type: | bool

  `GetLayerMode`()

    Return type: | bool

  `GetNameMode`()

    Return type: | bool

  `Perform`()

    Parameters: | doc (Handle_TDocStd_Document &) – filename (TCollection_AsciiString &) –
    Return type: | bool

    - Transfers a document and writes it to a IGES file Returns True if translation is OK

    Parameters: | doc (Handle_TDocStd_Document &) – filename (char *) –
    Return type: | bool

  `SetColorMode`()
    - Set ColorMode for indicate write Colors or not.

    Parameters: | colormode (bool) –
    Return type: | None

  `SetLayerMode`()
    - Set LayerMode for indicate write Layers or not.

    Parameters: | layermode (bool) –
    Return type: | None

  `SetNameMode`()
    - Set NameMode for indicate write Name or not.

    Parameters: | namemode (bool) –
    Return type: | None

  `Transfer`()
    - Transfers a document to a IGES model Returns True if translation is OK

    Parameters: | doc (Handle_TDocStd_Document &) –
    Return type: | bool

  `thisown`

    The membership flag

class `SwigPyIterator`(*args, **kwargs)

  Bases: `object`

  `advance`()
  `copy`()
  `decr`()
  `distance`()
  `equal`()
  `incr`()
  `next`()
  `previous`()
  `thisown`

    The membership flag

  `value`()

class `igescafcontrol`

  Bases: `object`

  static `DecodeColor`(*args)
    - Provides a tool for writing IGES file Converts IGES color index to CASCADE color

    Parameters: | col (int) –
    Return type: | Quantity_Color

  static `EncodeColor`(*args)
    - Tries to Convert CASCADE color to IGES color index If no corresponding color defined in IGES, returns 0

    Parameters: | col (Quantity_Color &) –
    Return type: | int

  `thisown`

    The membership flag

`igescafcontrol_DecodeColor`(*args)
  - Provides a tool for writing IGES file Converts IGES color index to CASCADE color

  Parameters: | col (int) –
  Return type: | Quantity_Color

`igescafcontrol_EncodeColor`(*args)
  - Tries to Convert CASCADE color to IGES color index If no corresponding color defined in IGES, returns 0

  Parameters: | col (Quantity_Color &) –
  Return type: | int

`register_handle`(handle, base_object)

  Inserts the handle into the base object to prevent memory corruption in certain cases