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

An arrangement automatic places items with the help of a base geometry. More...

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

Public Member Functions

 DbArrangement (DbCurve^ pBaseGeometry, DbEntity^ pItemToArrange)
 Creates an arrangement out of a geometry and an item to arrange. More...
 
void StartEdit ()
 Saves the current state of this arrangement. More...
 
void CancelEdit ()
 Cancels all changes since StartEdit was called. More...
 
void EndEdit ()
 End edit mode and creates an undo step for all changes. More...
 
void ResetAvailableItems ()
 Reset position and rotation of all available items. More...
 
void RefillDeletedItems ()
 Create new items for all deleted items. More...
 
- Public Member Functions inherited from X3g::Plugin::DbBlockReference
 DbBlockReference (Block^ pOwner, String^ pBlock)
 Creates a block reference to the given block. More...
 
 DbBlockReference (Block^ pOwner, Block^ pBlock)
 Creates a block reference to the given block. More...
 
 DbBlockReference (Block^ pOwner, Block^ pBlock, String^ pCustomType, Object^ pCustomObject)
 Creates a block reference to the given block. More...
 
GeMatrixGetTransform ()
 Returns transformation of the block reference. More...
 
void SetTransform (GeMatrix^ pTransform)
 Sets transformation of the block reference. More...
 
array< String^ >^ GetAttributes ()
 Returns a list of all attributes. More...
 
DbBlockReferenceCloneLinked ()
 Clones the block reference and links it with the copy. More...
 
bool OpenBlock ()
 Opens the referenced block to work with child entities (e.g. More...
 
void CloseBlock ()
 Close the referenced block and all child entities. 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

ArrangementType Type [get, set]
 Basic type of this arrangement. More...
 
bool IsAreaTypeAllowed [get]
 Returns true if DbArrangement::Type can be set to ArrangementType::Area. More...
 
ArrangementVPlacement VerticalPlacement [get, set]
 Vertical item placement of this arrangement. More...
 
bool AlignToBase [get, set]
 If true items will be rotated with the help of the base geometry. More...
 
double ItemsXRotation [get, set]
 Additional rotation of all items around x-axis. More...
 
double ItemsYRotation [get, set]
 Additional rotation of all items around y-axis. More...
 
double ItemsZRotation [get, set]
 Additional rotation of all items around z-axis. More...
 
ArrangementDistributionType DistributionType [get, set]
 Item distribution of this arrangement. More...
 
double ColumnOffset [get, set]
 Offset from base point to first column. More...
 
double RowOffset [get, set]
 Offset from base point to first row. More...
 
double ColumnGap [get, set]
 Gap between two columns. More...
 
double RowGap [get, set]
 Gap between two rows. More...
 
int ColumnCount [get, set]
 Number of columns. More...
 
int RowCount [get, set]
 Number of rows. More...
 
bool ItemsCompleteInside [get, set]
 If true only items that are complete inside the base geometry will be displayed. More...
 
- Properties inherited from X3g::Plugin::DbBlockReference
String^  Block [get, set]
 The referenced block, identified by the block name. More...
 
GeVec3d Position [get, set]
 Position of this block reference. More...
 
GeQuat Rotation [get, set]
 Rotation of this block reference. More...
 
GeVec3d Scale [get, set]
 Scale of this block reference. More...
 
bool IsBlockOpen [get]
 Returns true if the referenced block is open for edit. 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::DbBlockReference
System::EventHandler^  IsBlockOpenChanged
 Occurs when DbBlockReference::IsBlockOpen changed. More...
 

Detailed Description

An arrangement automatic places items with the help of a base geometry.

Constructor & Destructor Documentation

X3g::Plugin::DbArrangement::DbArrangement ( DbCurve pBaseGeometry,
DbEntity pItemToArrange 
)

Creates an arrangement out of a geometry and an item to arrange.

Both parameters must not be null.

Member Function Documentation

void X3g::Plugin::DbArrangement::CancelEdit ( )

Cancels all changes since StartEdit was called.

void X3g::Plugin::DbArrangement::EndEdit ( )

End edit mode and creates an undo step for all changes.

void X3g::Plugin::DbArrangement::RefillDeletedItems ( )

Create new items for all deleted items.

void X3g::Plugin::DbArrangement::ResetAvailableItems ( )

Reset position and rotation of all available items.

void X3g::Plugin::DbArrangement::StartEdit ( )

Saves the current state of this arrangement.

Everytime this function is call DbArrangement::CancelEdit() or DbArrangement::EndEdit() should be called.

Property Documentation

bool X3g::Plugin::DbArrangement::AlignToBase
getset

If true items will be rotated with the help of the base geometry.

int X3g::Plugin::DbArrangement::ColumnCount
getset

Number of columns.

This property will only be used if DbArrangement::DistributionType is not set to ArrangementDistributionType::Manual.

double X3g::Plugin::DbArrangement::ColumnGap
getset

Gap between two columns.

This property will only be used if DbArrangement::DistributionType is set to ArrangementDistributionType::Manual.

double X3g::Plugin::DbArrangement::ColumnOffset
getset

Offset from base point to first column.

This property will only be used if DbArrangement::DistributionType is set to ArrangementDistributionType::Manual.

ArrangementDistributionType X3g::Plugin::DbArrangement::DistributionType
getset

Item distribution of this arrangement.

bool X3g::Plugin::DbArrangement::IsAreaTypeAllowed
get

Returns true if DbArrangement::Type can be set to ArrangementType::Area.

bool X3g::Plugin::DbArrangement::ItemsCompleteInside
getset

If true only items that are complete inside the base geometry will be displayed.

This property will only be used if DbArrangement::Type is set to ArrangementType::Area.

double X3g::Plugin::DbArrangement::ItemsXRotation
getset

Additional rotation of all items around x-axis.

double X3g::Plugin::DbArrangement::ItemsYRotation
getset

Additional rotation of all items around y-axis.

double X3g::Plugin::DbArrangement::ItemsZRotation
getset

Additional rotation of all items around z-axis.

int X3g::Plugin::DbArrangement::RowCount
getset

Number of rows.

This property will only be used if DbArrangement::Type is set to ArrangementType::Area and DbArrangement::DistributionType is not set to ArrangementDistributionType::Manual.

double X3g::Plugin::DbArrangement::RowGap
getset

Gap between two rows.

This property will only be used if DbArrangement::Type is set to ArrangementType::Area and DbArrangement::DistributionType is set to ArrangementDistributionType::Manual.

double X3g::Plugin::DbArrangement::RowOffset
getset

Offset from base point to first row.

This property will only be used if DbArrangement::Type is set to ArrangementType::Area and DbArrangement::DistributionType is set to ArrangementDistributionType::Manual.

ArrangementType X3g::Plugin::DbArrangement::Type
getset

Basic type of this arrangement.

The type can only be set to ArrangementType::Area if the area type is allowed. Otherwise this property always returns ArrangementType::AlongPath.

ArrangementVPlacement X3g::Plugin::DbArrangement::VerticalPlacement
getset

Vertical item placement of this arrangement.