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::OverlayImage3d Class Reference

An image wich is rendered as 3d overlay. More...

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

Public Member Functions

 OverlayImage3d ()
 Creates an image. More...
 
void SetImage (array< unsigned char >^pData, int pWidth, int pHeight, PixelFormat pFormat)
 Sets image data. More...
 

Properties

GeVec3d Origin [get, set]
 Origin in world space. More...
 
bool FixedSize [get, set]
 Image rendered with original pixel size regardless of camera position and zoom. More...
 
bool HideOccluded [get, set]
 Hides overlay image if it is occluded by a regular entity. More...
 
bool ScreenAligned [get, set]
 Image facing torwards viewer (billboard). More...
 
double ViewingAngle [get, set]
 Hides overlay image if observation point is outside of viewing angle. More...
 
- Properties inherited from X3g::Plugin::OverlayEntity3d
System::Drawing::Color Color [get, set]
 The entity color. More...
 
GeMatrix^  Transform [get, set]
 Transformation of the entity. More...
 
OverlayLevel3d 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 wich is rendered as 3d overlay.

Untransformed image has center in origin and is facing positive z-direction. Width and height are one unit. The image is without database representation.

Constructor & Destructor Documentation

X3g::Plugin::OverlayImage3d::OverlayImage3d ( )

Creates an image.

Member Function Documentation

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

Sets image data.

Width and height in pixels.

Property Documentation

bool X3g::Plugin::OverlayImage3d::FixedSize
getset

Image rendered with original pixel size regardless of camera position and zoom.

bool X3g::Plugin::OverlayImage3d::HideOccluded
getset

Hides overlay image if it is occluded by a regular entity.

Works for fixed size images only. See OverlayImage3d::FixedSize.

GeVec3d X3g::Plugin::OverlayImage3d::Origin
getset

Origin in world space.

bool X3g::Plugin::OverlayImage3d::ScreenAligned
getset

Image facing torwards viewer (billboard).

double X3g::Plugin::OverlayImage3d::ViewingAngle
getset

Hides overlay image if observation point is outside of viewing angle.

Angle in [0,180]. Works for fixed size images only. See OverlayImage3d::FixedSize.