pCon.planner Plugin SDK  Version 8.8.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events
Public Member Functions | Properties | List of all members
X3g::Plugin::OverlayImage2d Class Reference

An image which is rendered as 2d overlay. More...

Inheritance diagram for X3g::Plugin::OverlayImage2d:
Inheritance graph
[legend]

Public Member Functions

 OverlayImage2d (View^ pView)
 Creates an image in view overlay. More...
 
void SetImage (array< unsigned char >^pData, int pWidth, int pHeight, PixelFormat pFormat)
 Sets image data. More...
 

Properties

GeVec2d Position [get, set]
 Position of top left image corner in view projection space. More...
 
GeVec2d Offset [get, set]
 Image offset from it's origin position in pixels. More...
 
bool DisplayScaling [get, set]
 Enables automatic scaling of offset and size for high DPI display devices. More...
 
- Properties inherited from X3g::Plugin::OverlayEntity2d
OverlayLevel2d Level [get, set]
 Overlay has several levels. More...
 
- Properties inherited from X3g::Plugin::OverlayEntity
bool Visible [get, set]
 Allows to change visibility. More...
 
bool Printable [get, set]
 If set to true the overlay element will be included during printing. More...
 
System::String^  ToolTip [get, set]
 Text shown near mouse pointer when it hovers over this entity. More...
 
System::String^  StatusMessage [get, set]
 Text shown in status bar when mouse pointer hovers over this entity. More...
 

Additional Inherited Members

- Events inherited from X3g::Plugin::OverlayEntity
System::EventHandler^  Click [add, remove, raise]
 Occurs when a OverlayEntity is clicked. More...
 
System::EventHandler^  MouseEnter [add, remove, raise]
 Occurs when the mouse pointer enters this entity. More...
 
System::EventHandler^  MouseLeave [add, remove, raise]
 Occurs when the mouse pointer leaves this entity. More...
 

Detailed Description

An image which is rendered as 2d overlay.

Constructor & Destructor Documentation

X3g::Plugin::OverlayImage2d::OverlayImage2d ( View pView)

Creates an image in view overlay.

Member Function Documentation

void X3g::Plugin::OverlayImage2d::SetImage ( array< unsigned char >^  pData,
int  pWidth,
int  pHeight,
PixelFormat  pFormat 
)

Sets image data.

Width and height in pixels.

Property Documentation

bool X3g::Plugin::OverlayImage2d::DisplayScaling
getset

Enables automatic scaling of offset and size for high DPI display devices.

Enabled by default.

GeVec2d X3g::Plugin::OverlayImage2d::Offset
getset

Image offset from it's origin position in pixels.

Offset is affected by display scaling.

GeVec2d X3g::Plugin::OverlayImage2d::Position
getset

Position of top left image corner in view projection space.