Operator Reference

HALCON Operator Reference / Graphics / Parameters
ClassesClasses | | Operators

get_shapeT_get_shapeGetShapeGetShapeget_shape (Operator)

get_shapeT_get_shapeGetShapeGetShapeget_shape — Get the current region output shape.

Signature

get_shape( : : WindowHandle : DisplayShape)

Herror T_get_shape(const Htuple WindowHandle, Htuple* DisplayShape)

void GetShape(const HTuple& WindowHandle, HTuple* DisplayShape)

HString HWindow::GetShape() const

static void HOperatorSet.GetShape(HTuple windowHandle, out HTuple displayShape)

string HWindow.GetShape()

def get_shape(window_handle: HHandle) -> str

Description

get_shapeget_shapeGetShapeGetShapeget_shape returns the shape in which regions are displayed. The available shapes can be queried with query_shapequery_shapeQueryShapeQueryShapequery_shape and then changed with set_shapeset_shapeSetShapeSetShapeset_shape.

Execution Information

  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).
  • Multithreading scope: global (may be called from any thread).
  • Processed without parallelization.

Parameters

WindowHandleWindowHandleWindowHandlewindowHandlewindow_handle (input_control)  window → HWindow, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Window handle.

DisplayShapeDisplayShapeDisplayShapedisplayShapedisplay_shape (output_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Current region output shape.

Result

get_shapeget_shapeGetShapeGetShapeget_shape returns 2 ( H_MSG_TRUE) if the window is valid. Otherwise an exception is raised.

Possible Predecessors

query_shapequery_shapeQueryShapeQueryShapequery_shape

Possible Successors

set_shapeset_shapeSetShapeSetShapeset_shape, disp_regiondisp_regionDispRegionDispRegiondisp_region

See also

set_shapeset_shapeSetShapeSetShapeset_shape, query_shapequery_shapeQueryShapeQueryShapequery_shape, disp_regiondisp_regionDispRegionDispRegiondisp_region

Module

Foundation

ClassesClasses | | Operators