![]() |
pCon.planner Plugin SDK
Version 8.9
|
Base class for graphical objects without database representation. More...
Public Member Functions | |
void | Delete () |
Deletes the overlay entity. More... | |
Properties | |
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... | |
Events | |
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... | |
Base class for graphical objects without database representation.
This kind of objects are rendered as overlay on the actual scene. They are intended to be used for temporary graphical feedback and interactive manipulation (e.g. bounding boxes and buttons). For the latter purpose it's possible to register according event handlers. The objects become visible on instantiation. Property OverlayEntity::Visible allows temporary hiding. Overlay entities which are no longer needed must be released by calling OverlayEntity::Delete. Otherwise the graphical representation would stay in memory.
void X3g::Plugin::OverlayEntity::Delete | ( | ) |
Deletes the overlay entity.
This invalidates the entity and it must no longer be used. For OverlayEntity this is the same as calling Dispose().
|
getset |
If set to true the overlay element will be included during printing.
|
getset |
Text shown in status bar when mouse pointer hovers over this entity.
|
getset |
Text shown near mouse pointer when it hovers over this entity.
|
getset |
Allows to change visibility.
Invisible entities don't receive mouse events.
|
addremoveraise |
Occurs when a OverlayEntity is clicked.
|
addremoveraise |
Occurs when the mouse pointer enters this entity.
|
addremoveraise |
Occurs when the mouse pointer leaves this entity.