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

Layout viewport item. More...

Inheritance diagram for X3g::Plugin::Layout::DbViewport:
Inheritance graph
[legend]

Public Member Functions

void GetDimensions ([Out] double% pWidth,[Out] double% pHeight)
 Get dimensions of the DbViewport. More...
 
void SetDimensions (double pWidth, double pHeight)
 Set dimensions of the DbViewport. More...
 
- Public Member Functions inherited from X3g::Plugin::DbEntity
GeMatrixGetTextureMatrix ()
 The texture matrix determines how to map the material texture to the entity. More...
 
void SetTextureMatrix (GeMatrix^ pMatrix)
 Sets the texture matrix. More...
 
bool TransformBy (GeMatrix^ pTransform)
 Transforms the entity. More...
 
GeMatrixGetTransientTransform ()
 Returns transient transformation of this entity. More...
 
void SetTransientTransform (GeMatrix^ pTransform)
 Sets the transient transformation of this entity. More...
 
void UpdateGeometry ()
 Updates the geometry of the entity. More...
 
void Delete ()
 Deletes the entity from the document. More...
 
GeBoundingBox3dGetBoundingBox (GeMatrix^ pTransform)
 Returns bounding box of entity within the owning blocks local coordinate system. More...
 
IPropertyProvider^ GetPropertyProvider ()
 Returns property provider of the entity. More...
 
DbEntityClone (Block^ pOwner)
 Creates a clone of the entity. More...
 
DbEntityCut2 (DbEntity^ pEntity)
 Subtracts pEntity from this object. More...
 
DbEntityCut2 (DbEntity^ pEntity, Block^ pToOwner)
 Subtracts pEntity from this object. More...
 
DbEntityCommon2 (DbEntity^ pEntity)
 Computes an object which represents all common geometry of this entity and pEntity. More...
 
DbEntityCommon2 (DbEntity^ pEntity, Block^ pToOwner)
 Computes an object which represents all common geometry of this entity and pEntity. More...
 
DbEntityFuse2 (DbEntity^ pEntity)
 Computes an object by merging all geometry of this entity and pEntity. More...
 
DbEntityFuse2 (DbEntity^ pEntity, Block^ pToOwner)
 Computes an object by merging all geometry of this entity and pEntity. More...
 
List< DbEntity^ >^ Slice (GePlane^ pPlane, bool pKeepBothHalves)
 Slice the DbEntity with the plane. More...
 
DbEntityPartialMove (GePlane^ pPlane, double pLength)
 Strech or shrink the DbEntity at the given plane. More...
 
void AddCallbacks (DbEntityCallbacks^ pCallbacks)
 Add callbacks to the entity. More...
 
void RemoveCallbacks (DbEntityCallbacks^ pCallbacks)
 Remove callbacks from entity. More...
 

Properties

GeVec2d Position [get, set]
 Position of this item. More...
 
ICamera^  Camera [get]
 Interface to camera parameters. More...
 
IRenderStyle^  RenderStyle [get, set]
 Get or set the RenderingStyle for this viewport. More...
 
bool IsScaleLocked [get, set]
 If true the user can not change the scale by accident. More...
 
DbViewportBackground Background [get, set]
 Background type of this viewport. More...
 
- Properties inherited from X3g::Plugin::DbEntity
String^  Id [get]
 The unqiue id of the entity. More...
 
String^  Name [get, set]
 User-defined name of the entity. More...
 
String^  Material [get, set]
 Material of this entity. More...
 
EntityColor Color [get, set]
 Color of this entity. More...
 
String^  Layer [get, set]
 Layer name of this entity. More...
 
String^  OwningBlock [get]
 Name of the block that owns this entity. More...
 
bool TopLevel [get]
 Returns if entity is owned by modelspace. More...
 
bool Valid [get]
 Returns if entity is valid and not erased. More...
 
DbTextureProjection TextureProjection [get, set]
 The AutoCAD texture projection. More...
 
bool IsModelingSupported [get]
 If true the entity can be used with modeling functions. More...
 
bool Locked [get, set]
 Lock status of this entity. More...
 
GeVec2d LayoutPosition [get, set]
 Position the Entity in Layout. More...
 
DbDictionary^  CustomData [get]
 Allows to attach custom data to the entity. More...
 
String^  CustomType [get, set]
 Allows plugins to identify their entities. More...
 
Object^  CustomObject
 Allows to attach an object which extents the entity (e.g. More...
 
bool IsVisible [get, set]
 Visibility of this entity. More...
 
Hyperlink Link [get, set]
 Get or Set the Hyperlink attached to the DbEntity. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from X3g::Plugin::DbEntity
static DbEntityFromId (String^ pEntityId)
 Creates DbEntity to given entity id. More...
 
- Package Functions inherited from X3g::Plugin::DbEntity
 DbEntity (Block^ pOwner, EntityImpl *pImpl)
 This constructor is used to create new OdDbEntities and add to a block. More...
 
 DbEntity (Layout::Page^ pPage, EntityImpl *pImpl)
 This constructor is used to create new OdDbEntities and add to a page. More...
 
- Events inherited from X3g::Plugin::DbEntity
System::EventHandler^  VisibilityChanged
 Occurs when DbEntity::IsVisible changed. More...
 

Detailed Description

Layout viewport item.

Member Function Documentation

void X3g::Plugin::Layout::DbViewport::GetDimensions ( [Out] double%  pWidth,
[Out] double%  pHeight 
)

Get dimensions of the DbViewport.

void X3g::Plugin::Layout::DbViewport::SetDimensions ( double  pWidth,
double  pHeight 
)

Set dimensions of the DbViewport.

Property Documentation

DbViewportBackground X3g::Plugin::Layout::DbViewport::Background
getset

Background type of this viewport.

ICamera^ X3g::Plugin::Layout::DbViewport::Camera
get

Interface to camera parameters.

It's not allowed to assign another camera reference. Use ICamera::CopyFrom() instead.

bool X3g::Plugin::Layout::DbViewport::IsScaleLocked
getset

If true the user can not change the scale by accident.

This feature is only available if ICamera::Projection of this DbViewport::Camera is set to CameraProjection::Orthographic.

GeVec2d X3g::Plugin::Layout::DbViewport::Position
getset

Position of this item.

IRenderStyle^ X3g::Plugin::Layout::DbViewport::RenderStyle
getset

Get or set the RenderingStyle for this viewport.

It is bad practive to get an IRenderingStyle from this handle to modify it. The reason beeing that IRenderStyle are globally defined styles, and modifications can have undesired side effects.