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

Base class for graphical objects without database representation. More...

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

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...
 

Detailed Description

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.

Member Function Documentation

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().

Property Documentation

bool X3g::Plugin::OverlayEntity::Printable
getset

If set to true the overlay element will be included during printing.

System:: String^ X3g::Plugin::OverlayEntity::StatusMessage
getset

Text shown in status bar when mouse pointer hovers over this entity.

System:: String^ X3g::Plugin::OverlayEntity::ToolTip
getset

Text shown near mouse pointer when it hovers over this entity.

bool X3g::Plugin::OverlayEntity::Visible
getset

Allows to change visibility.

Invisible entities don't receive mouse events.

Event Documentation

System:: EventHandler^ X3g::Plugin::OverlayEntity::Click
addremoveraise

Occurs when a OverlayEntity is clicked.

System:: EventHandler^ X3g::Plugin::OverlayEntity::MouseEnter
addremoveraise

Occurs when the mouse pointer enters this entity.

System:: EventHandler^ X3g::Plugin::OverlayEntity::MouseLeave
addremoveraise

Occurs when the mouse pointer leaves this entity.