rpti::item::image

Interact with items of type image.

Supported Property Names

To set image properties, use the following properties:

label

Caption and Location of caption.

Value: String, Below Image/ Above Image.

hw_page

Model location

Value: Page 1/Window 2

hw_output

Output Type

Value: PNG/JPEG/TIFF, for HyperMesh and other clients; PNG/JPEG/TIFF/GIF/H3D, for HyperView and MediaView (in Document mode); PNG/JPEG/TIFF/GIF/AVI/H3D, for HyperView and MediaView (in Presentation mode)

crop

Crop an image.

Value: 0 or 1.

hw_best_view

Best view.

Value: 0 or 1.; Enable or disable Best View

hw_view_modes

View mode.

Value: Isometric View, XY Top View, XY Bottom View, ZX Right View, XZ Left View, ZY Front View and YZ Rear View
Note: Applied only for HM/MV; HV view modes- Global View, Global Components,Global Regions, Global Spheres, Selection Transparency, Selection Isolate, Local Entity Zoom, Local Transparency, Local Contour, Isometric View, XY Top View, XY Bottom View, ZX Right View, XZ Left View, ZY Front View and YZ Rear View.

hv_enable_note

Create Note.

Value: 0 or 1.

hv_note_on

Note Location.

Value: Maximum of Contour, Minimum of Contour and Hotspots of Contour.

hv_find_hotspots_at

Find Hotspots.

Value: Above Threshold and Below Threshold.

hv_hotspot_threshold

Threshold

Value: Number

hv_hotspot_distance

Zone Distance

Value: Number

hv_number_of_hotspots

Maximum Hotspots

Value: Number

hv_note_text

Note Text

Value: String

Example: Value: { format %0.3f {entity.contour_max}}

hv_note_bg_color

Fill Color

Value: rgbcolor

Example: "200 100 100"

hv_note_fill_color_mode

Fill Color Mode

Value: User, Component and Contour.

hv_note_text_color

Text Color

Value: rgbcolor

hv_note_text_color_mode

Text Color Mode

Value: User, Maintain Contrast, Component and Contour.

hv_note_align_text

Align Text

Value: Left, Center and Right.

hv_note_border_thickness

Border thickness

Value: Number (0-4)

hv_note_border_color

Border Color

Value: rgbcolor

hv_note_border_color_mode

Border Color Mode

Value: User, Component and Contour.

hv_note_border_color_mode

Border Color Mode

Value: User, Component and Contour.

hv_note_font_family

Font Family

Value: String

hv_note_font_style

Font Style

Value: Regular, Italic, Bold and Bold Italic

hv_note_font_size

Font Size

Value: Number

hv_note_transparent

Enable Transparency

Value: 0 or 1

hv_note_shape

Note Shape

Value: Rectangle, Circle and Ellipse.

hv_note_position_to_attachment: Note Position To Attachment

hv_note_auto_hide

AutoHide

Value: 0 or 1

hv_note_screen_anchor

ScreenAnchor

Value: 0 or 1

hv_hide_local_system

Hide Local System

Value: 0 or 1

hv_hide_modelinfo_note

Hide Model Info Note

Value: 0 or 1

hv_auto_fit

AutoFit

Value: 0 or 1

hv_legend_file

Legend file

Value: Valid legend file name with full path

hv_update_legend

Set Dynamic Legend

Value: 0 or 1

hv_capture_option

Capture option.

Value: Legend and Graphics Area, Graphics Area and Legend only.

Example

::rpti::item set -id $imageobid -label "My Image" -position "Above
                            Image"

::rpti::item GetPropertykeylist

rpti::item::image create

Creates an item of type "image".

Syntax: rpti::item::image create

Parameters

For: Value: A full list of standard property names see Supported property name above.

Returns: The ID of the item or .tcl-error in case an error occurred during creation.

Example: rpti::item::image create -name "My Image Item"

rpti::item::image delete

Deletes the item with the specified ID.

Syntax: rpti::item::image delete

Parameters

-id: Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.

Returns: 1 for OK, .tcl-error in case of error.

Example: rpti::item::image delete -id $id

rpti::item::image get

Queries the value of one property.

Syntax: rpti::item::image get

Parameters

-id: Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.

For: Value: A full list of standard property names see Supported property name above.

Returns: The value of the specified property or .tcl-error in case of error.

Example: rpti::item::image get -id $id -property parent

rpti::item::image getpropertyid

Queries ID of property.

Syntax: rpti::item::image getpropertyid

Parameters

-id: Value: Item ID.

-key: Value: Property key.

rpti::item::image getpropertykeylist

Queries list of properties.

Syntax: rpti::item::image getpropertykeylist

Parameters

-id: Value: Item ID. The item ID which is returned by the corresponding "create" API.

Returns: List of property keys for a particular item ID.

rpti::item::image set

Sets one or multiple parameters to specified values. The type of the item is assigned upon creation and cannot be changed after.

Syntax: rpti::item::image set

Parameters

-id: Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.

-file: Value: A full list of standard property names. See Supported Property Names above.
-config: Value: HwCaptureImage for capturing images from a given page and window.
-hwpage: Applicable when config is set to HwCaptureImage
-hwwindow: Applicable when config is set to HwCaptureImage

Additionally, follow the list of Supported Property Names above.

Returns: 1 for OK, .tcl-error in case of error.

Example

rpti::item::image set -id $id -name "My Image Item" -file "C:/temp/image1.png"

rpti::item::image set -id $id -config HwCaptureImage -hwpage 1 -hwwindow 4