pCon.planner Plugin SDK  Version 8.9
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events
Namespaces | Classes | Typedefs | Enumerations | Functions | Variables
X3g::Plugin Namespace Reference

generic plugin namespace More...

Namespaces

 Articles
 Namespace provides access to article handling.
 
 IO
 Namespace provides access to file import and export.
 
 Layout
 Namespace provides access to layout.
 
 Modeling
 Namespace provides access to modeling classes.
 
 Room
 Namespace provides access to different room elements.
 
 Tool
 Namespace provides access to different tools.
 

Classes

class  IActionManager
 Action Manager. More...
 
interface  IAppDialogOverride
 Allows to override application dialogs. More...
 
class  DefaultAppDialogOverride
 Implementation of IAppDialogOverride which lets application show all dialogs. More...
 
class  IAppManager
 Application Manager. More...
 
class  BackgroundParams
 Contains background parameter for Views. More...
 
class  Block
 Blocks are containers for entities within a planning. More...
 
struct  SaveBlockParams
 Block export parameters. More...
 
class  BlockManager
 Block Manager. More...
 
class  CannotExplodeEntityException
 CannotExplodeEntityException Thrown if a database entity could not be exploded. More...
 
interface  ICamera
 Common camera interface. More...
 
class  Camera
 Implementation of a common camera without visual representation in the planning. More...
 
class  CameraAnimationNode
 Camera Animation Node. More...
 
struct  CameraAnimationInfo
 Camera Animation Information. More...
 
struct  CameraAnimationFrame
 Camera Animation Frame. More...
 
class  CameraAnimation
 Camera Animation. More...
 
class  CameraEntity
 Camera entity. More...
 
class  CameraManager
 Camera Manager. More...
 
class  DbArrangement
 An arrangement automatic places items with the help of a base geometry. More...
 
class  DbCurve
 Base class for all curves. More...
 
class  DbCircle
 A simple closed circle. More...
 
class  DbEllipse
 An ellipse. More...
 
class  DbPolyline
 A line with two or more vertices. More...
 
class  DbDictionary
 A dictionary stores arbitrary data as key value pairs. More...
 
class  DbDimension
 Base class for all dimension types. More...
 
class  DbAlignedDimension
 A length dimension with a dimension line parallel to measuring points. More...
 
class  DbArcDimension
 A length dimension to measure an arc. More...
 
class  DbDiametricDimension
 A length dimension used to measure a diameter. More...
 
class  DbRadialDimension
 A length dimension used to measure a radius. More...
 
class  DbRotatedDimension
 A length dimension with a dimension line rotated to measuring points. More...
 
class  DbThreePointAngularDimension
 An angular dimension based on center point and to mesuring points. More...
 
class  DbTwoLineAngularDimension
 An angular dimension between two lines. More...
 
struct  EntityColor
 Color of an entity. More...
 
struct  Hyperlink
 Interfaces an ACAD Hyperlink. More...
 
class  DbEntityCallbacks
 Abstract base class for entity callbacks. More...
 
class  DbEntity
 Base class for all database objects having a graphical representation. More...
 
class  DbBlockReference
 A block reference is used to place, size, and display an instance of the collection of entities within a DbBlock that it references. More...
 
class  DbAttributeDefinition
 Attribute definitions are used to define tags, or labels, for blocks. More...
 
class  DbAttribute
 Attributes are tags, or labels, for blocks. More...
 
class  DbLight
 A light source which is part of the document. More...
 
class  DbMesh
 A DbMesh is a collection of polygons used to define a 3D object. More...
 
class  DbSolid
 A DbSolid indicates a geometrical object defined by paramters. More...
 
class  DbPoint
 A point in 3D space. More...
 
class  DbPointCloud
 A point cloud. More...
 
class  DbImage
 A raster image. More...
 
class  DbText
 A text entity. More...
 
class  DimensionStyle
 A style for dimensions. More...
 
class  DimensionStyleManager
 This class manage dimension styles of current document. More...
 
class  GeometryUpdateEventArgs
 Event arguments for geometry update of top-level entities. More...
 
class  LayersChangedEventArgs
 Event arguments for layer(s) changed. More...
 
class  DocumentManager
 Document Manager. More...
 
class  DocumentSummary
 Document Summary. More...
 
class  GeDrawable
 Root class of all drawables. More...
 
class  GeGeometry
 Geometry. More...
 
class  GePoints
 A set of points. More...
 
class  GePolylines
 A set of polylines of the same color. More...
 
class  GeMesh
 Mesh data for 3d geometry. More...
 
class  GeComponentInstance
 A component instance instanciates and transforms a component. More...
 
class  GeComponent
 Container for a set of drawables. More...
 
struct  ExportParams
 Params for modelspace export of GeometryManager. More...
 
struct  Export3dsParams
 3DS export parameters. More...
 
struct  ExportDaeParams
 Dae export parameters. More...
 
struct  ExportSkpParams
 Skp export parameters. More...
 
struct  ExportFbxParams
 Fbx export parameters. More...
 
struct  FbxFormatDescription
 Description of a supported FBX format. More...
 
struct  ExportObjParams
 Obj export parameters. More...
 
struct  ExportEgmParams
 Egm export parameters. More...
 
struct  ExportOffParams
 Off export parameters. More...
 
class  GeometryManager
 Geometry Manager. More...
 
class  Image
 Holds an image. More...
 
class  IImage
 Wraps an object of class Image. More...
 
interface  IMessageBox
 Interface for custom message boxes. More...
 
class  Layer
 Layers are used to group information in a drawing by function and to enforce linetype, color, and other standards. More...
 
class  LayerManager
 Layer Manager. More...
 
class  LightManager
 Light Manager. More...
 
class  LogEventArgs
 Arguments for log event. More...
 
class  Logger
 This class helps to use logging mechanism of pCon.planner. More...
 
struct  SoundAbsorption
 Sound absorption values. More...
 
class  MaterialUtility
 Provides helper functions for material handling. More...
 
class  Material
 Material describes how an object interacts with light. More...
 
class  MaterialChangedEventArgs
 Event arguments for change of a material. More...
 
class  MaterialManager
 Material Manager. More...
 
class  MessageBox
 Static class to group message box functionality. More...
 
class  OverlayEntity
 Base class for graphical objects without database representation. More...
 
class  OverlayEntity3d
 Base class for 3d overlay entities. More...
 
class  OverlayPointSet3d
 A graphical point set without database representation. More...
 
class  OverlayPolyline3d
 A graphical polyline without database representation. More...
 
class  OverlayMesh3d
 A graphical triangle mesh without database representation. More...
 
class  OverlayText3d
 A graphical text without database representation. More...
 
class  OverlayImage3d
 An image wich is rendered as 3d overlay. More...
 
class  OverlayEntity2d
 Base class for 2d overlay entities. More...
 
class  OverlayImage2d
 An image which is rendered as 2d overlay. More...
 
interface  IProperty
 Property. More...
 
interface  IPropertyDescriptor
 Describes a property. More...
 
class  PropertyDescriptor
 Default implementation of IPropertyDescriptor. More...
 
class  PropertiesChangedEventArgs
 Provides information about property changes. More...
 
class  PropertyProvider
 Property Provider. More...
 
interface  IPropertyCallbacks
 Allows to implement your own properties and add them to a provider. More...
 
class  PropertyValue
 Base class for various value properties. More...
 
class  BoolPropertyValue
 Boolean Property Value. More...
 
class  IntPropertyValue
 Integer Property Value. More...
 
class  StringPropertyValue
 String Property Value. More...
 
class  DoublePropertyValue
 Double Property Value. More...
 
class  ColorPropertyValue
 Color Property Value. More...
 
class  LengthPropertyValue
 Length Property Value. More...
 
class  ChoicePropertyValue
 Choice Property Value. More...
 
class  TextPropertyValue
 Text (multi-line string) Property Value. More...
 
class  CurrencyPropertyValue
 Currency Property Value. More...
 
class  FontPropertyValue
 Font Property Value. More...
 
class  ImagePropertyValue
 Image Property Value. More...
 
interface  IRenderCallback
 Interface for the render callback to supervise render progress. More...
 
class  RenderProgressChangedEventArgs
 Event arguments for render progress changes. More...
 
class  Renderer
 The base class for all renderer. More...
 
class  IOpenGLRenderer
 Realtime OpenGL Renderer. More...
 
class  RendererManager
 Manages the Renderer available in the pCon.planner. More...
 
class  RenderLineStyle
 Describes a line style of a render style. More...
 
class  IRenderStyle
 A global registered Render style. More...
 
class  RenderStyleManager
 Manager for render styles. More...
 
interface  IToolTemplate
 Tool Template. More...
 
interface  ITool
 Tool. More...
 
struct  GeVec4f
 A four dimensional float vector or point. More...
 
struct  GeVec4d
 A four dimensional double vector or point. More...
 
struct  GeVec3f
 A three dimensional float vector or point. More...
 
struct  GeVec3d
 A three dimensional double vector or point. More...
 
struct  GeVec2f
 A two dimensional float vector or point. More...
 
struct  GeVec2d
 A two dimensional float vector or point. More...
 
struct  GeQuat
 Quaternion. More...
 
class  GeMatrix
 Matrix class. More...
 
class  GeBoundingBox3d
 Bounding box. More...
 
class  GePlane
 Plane. More...
 
class  Currency
 Currency class. More...
 
interface  ICommand
 Base interface for user defined commands More...
 
interface  IUndoManager
 Undo Manager. More...
 
class  IUtilities
 Utilities. More...
 
class  IVectorImage
 Vector Image. More...
 
class  IVectorRenderer
 Vector Image Renderer. More...
 
class  View
 A View. More...
 
class  DragDropEventArgs
 Provides data associated with drag'n'drop events and allows handlers to reply if they accept the drop. More...
 
class  ViewManager
 View manager. More...
 
class  Window
 Plugin host window. More...
 
class  Widget
 Allows to manage widgets of pCon.planner. More...
 
class  WindowManager
 Allows plugins to create and manage dockable windows. More...
 
class  SaveEventInfo
 Parameter for the save events. More...
 
class  InteractionEventInfo
 Parameter for interaction events. More...
 
class  EntityEventInfo
 Parameter interface for events about entities. More...
 
class  LicenseException
 License Exception. More...
 
interface  IModuleProvider
 Provides access to all major managers of the pCon.planner plugin interface. More...
 
class  Plugin
 The plugin interface. More...
 
class  IArticleEntityInfo
 Holds additional article information. More...
 
class  IArticleEntity
 Article interface for entities. More...
 
class  IArticleInstance
 Article Instance. More...
 
class  IOfmlArticleInstance
 Legacy class. More...
 
class  ICustomTextField
 Legacy class. More...
 
class  IUserArticleInstance
 Legacy class. More...
 
class  IArticleManager
 Article Manager. More...
 
class  IBasket
 Basket interface. More...
 
class  IBasketArticlePriceComponent
 Basket Article Price Component. More...
 
class  IBasketArticleCalculation
 Basket Article Calculation interface. More...
 
class  IBasketArticleTextField
 A basket article text field. More...
 
class  IBasketArticleFeature
 Basket Article Feature More...
 
class  IBasketArticleItem
 Basket Article Item. More...
 
class  IBasketCalcItem
 BasketCalcItem. More...
 
class  IBasketCalculation
 Basket Calculation. More...
 
class  IBasketItem
 Basket Item. More...
 
class  IBasketSetArticleItem
 Basket Set Article Item. More...
 
class  IFMItem
 Folder Manager Item. More...
 
class  IFMFolderItem
 Folder Manager Folder-Item. More...
 
class  IFMArticleItem
 Folder Manager Article-Item. More...
 
class  IFMSetArticleItem
 Folder Manager SetArticle-Item. More...
 
class  IFolderManager
 Folder Manager. More...
 
class  IOfmlObject
 Ofml Object. More...
 
class  IProjectSettings
 Project Settings. More...
 

Typedefs

typedef System::EventHandler
< GeometryUpdateEventArgs^ > 
GeometryUpdateEventHandler
 Event handler for updated geometry. More...
 
typedef System::EventHandler
< LayersChangedEventArgs^ > 
LayersChangedEventHandler
 Event handler for changed layer. More...
 
typedef System::EventHandler
< LogEventArgs^ > 
LogEventHandler
 Event handler for LogEventArgs. More...
 
typedef System::EventHandler
< MaterialChangedEventArgs^ > 
MaterialChangedEventHandler
 Event handler for changed material. More...
 
typedef System::EventHandler
< PropertiesChangedEventArgs^ > 
PropertiesChangedEventHandler
 Event handler for changed properties. More...
 
typedef System::EventHandler
< RenderProgressChangedEventArgs^ > 
RenderProgressChangedEventHandler
 Event handler for render progress changes. More...
 
typedef System::EventHandler
< DragDropEventArgs^ > 
DragDropEventHandler
 Event handler for a drag n' drop event. More...
 

Enumerations

enum  ArticleConversionType {
  ArticleConversionType::ConvertToUserArticle, ArticleConversionType::ExplodeArticle, ArticleConversionType::ExplodeConfiguration, ArticleConversionType::ExplodePlaceholder,
  ArticleConversionType::SplitUpArticle, ArticleConversionType::RemoveArticleData
}
 Determines a kind of article conversion. More...
 
enum  AppTerminateFlags : int { AppTerminateFlags::None = 0x0000, AppTerminateFlags::NoSave = 0x0001, AppTerminateFlags::NoCancel = 0x0002 }
 Flags for application termination. More...
 
enum  CameraProjection { CameraProjection::Perspective, CameraProjection::Orthographic, CameraProjection::Architectural, CameraProjection::Spherical }
 Types of camera projection. More...
 
enum  CameraAnimationNodeFlags : int { CameraAnimationNodeFlags::InterpolatePositionFirst = 0x0001, CameraAnimationNodeFlags::NormalizeDirection = 0x0002 }
 Camera Animation Node Flags. More...
 
enum  CameraInterpolation { CameraInterpolation::Linear, CameraInterpolation::SplineWeak, CameraInterpolation::SplineStrong }
 Determines the interpolation between camera animation nodes. More...
 
enum  ArrangementType { ArrangementType::AlongPath, ArrangementType::Area }
 Defines all possible arrangement types. More...
 
enum  ArrangementDistributionType {
  ArrangementDistributionType::ItemsCenter, ArrangementDistributionType::ItemsOuterEdge, ArrangementDistributionType::SymmetricInsideBase, ArrangementDistributionType::OnNodes,
  ArrangementDistributionType::Manual
}
 Defines types how to distribute items of an arrangement. More...
 
enum  ArrangementVPlacement { ArrangementVPlacement::Above, ArrangementVPlacement::Center, ArrangementVPlacement::Below, ArrangementVPlacement::ItemBased }
 Defines vertical placement of an arrangement. More...
 
enum  EntityColorMethod { EntityColorMethod::ByColor, EntityColorMethod::ByBlock, EntityColorMethod::ByLayer }
 Determines how the color of an entity should be computed. More...
 
enum  DbTextureProjection {
  DbTextureProjection::None, DbTextureProjection::Planar, DbTextureProjection::Box, DbTextureProjection::Cylinder,
  DbTextureProjection::Sphere
}
 Texture Projection. More...
 
enum  ArrowHeadType {
  ArrowHeadType::ArchTick, ArrowHeadType::BoxBlank, ArrowHeadType::BoxFilled, ArrowHeadType::ClosedTransparent,
  ArrowHeadType::ClosedBlank, ArrowHeadType::ClosedFilled, ArrowHeadType::DatumBlank, ArrowHeadType::DatumFilled,
  ArrowHeadType::DotBlank, ArrowHeadType::DotFilled, ArrowHeadType::DotSmallFilled, ArrowHeadType::DotSmallBlank,
  ArrowHeadType::Integral, ArrowHeadType::None, ArrowHeadType::Oblique, ArrowHeadType::Open15,
  ArrowHeadType::Open30, ArrowHeadType::Open90, ArrowHeadType::Origin, ArrowHeadType::Origin2
}
 Determines the type of arrows of an dimension line. More...
 
enum  DimensionTextHAlignment {
  DimensionTextHAlignment::Center, DimensionTextHAlignment::ByFirstExtension, DimensionTextHAlignment::BySecondExtension, DimensionTextHAlignment::AboveFirstExtension,
  DimensionTextHAlignment::AboveSecondExtension
}
 Determines the horizontal alignment of the dimension text. More...
 
enum  DimensionTextVAlignment { DimensionTextVAlignment::Top, DimensionTextVAlignment::Online, DimensionTextVAlignment::Bottom }
 Determines the vertical alignment of the dimension text. More...
 
enum  DocumentPurgeFlags : int {
  DocumentPurgeFlags::General = 0x0001, DocumentPurgeFlags::Materials = 0x0002, DocumentPurgeFlags::Layers = 0x0004, DocumentPurgeFlags::DimensionStyles = 0x0008,
  DocumentPurgeFlags::TextStyles = 0x0010, DocumentPurgeFlags::LineTypes = 0x0020, DocumentPurgeFlags::SetArticles = 0x0040, DocumentPurgeFlags::All = 0xffff
}
 Flags determining which parts of the document will get purged. More...
 
enum  DocumentFileFormat {
  DocumentFileFormat::Undefined, DocumentFileFormat::AutoCad2000, DocumentFileFormat::AutoCad2004, DocumentFileFormat::AutoCad2007,
  DocumentFileFormat::AutoCad2010, DocumentFileFormat::AutoCad2013, DocumentFileFormat::AutoCad2018
}
 The document file format version. More...
 
enum  DocumentFileType { DocumentFileType::Dwg, DocumentFileType::Dxf }
 The document file type. More...
 
enum  Export3DSCompatLevel { Export3DSCompatLevel::MeshInstances, Export3DSCompatLevel::Meshes }
 Compatibility setting for exporting to 3ds. More...
 
enum  SkpFormatVersion {
  SkpFormatVersion::Default , SkpFormatVersion::Skp6, SkpFormatVersion::Skp7, SkpFormatVersion::Skp8,
  SkpFormatVersion::Skp2013, SkpFormatVersion::Skp2014, SkpFormatVersion::Skp2015, SkpFormatVersion::Skp2016,
  SkpFormatVersion::Skp2017, SkpFormatVersion::Skp2018, SkpFormatVersion::Skp2019, SkpFormatVersion::Skp2020,
  SkpFormatVersion::Skp2021
}
 Version of skp format. More...
 
enum  ObjOrientation { , ObjOrientation::Y_Up }
 Orientation of the exported coordinates. More...
 
enum  GeometryCollectFlags : int {
  GeometryCollectFlags::None = 0x0000, GeometryCollectFlags::Collect2D = 0x0001, GeometryCollectFlags::Collect3D = 0x0002, GeometryCollectFlags::Collect2D3D = 0x0003,
  GeometryCollectFlags::CollectInvisible = 0x0004, GeometryCollectFlags::KeepDoubleSidedFaces = 0x0008
}
 Flags determining which kind of geometries will be collected. More...
 
enum  PixelFormat {
  PixelFormat::RGB24, PixelFormat::RGBA32, PixelFormat::GRAY8, PixelFormat::RGB96F,
  PixelFormat::RGBA128F
}
 Image pixel formats. More...
 
enum  ImageFormat { ImageFormat::JPEG, ImageFormat::PNG, ImageFormat::EXR }
 Image file formats. More...
 
enum  LogLevel : int {
  LogLevel::Fatal = 4, LogLevel::Error = 3, LogLevel::Warning = 2, LogLevel::Info = 1,
  LogLevel::Debug = 0
}
 Defines severity of log message. More...
 
enum  MaterialType { , MaterialType::Common, MaterialType::Glass , MaterialType::Illuminant }
 Determines the material type. More...
 
enum  TextureType { TextureType::BaseColor, TextureType::Metallic, TextureType::Normal, TextureType::Roughness }
 Determines texture type. More...
 
enum  OverlayLevel3d : int { OverlayLevel3d::InScene = 0, OverlayLevel3d::Middle = 4 }
 Overlay has several levels. More...
 
enum  OverlayLevel2d : int { OverlayLevel2d::Background = 2, OverlayLevel2d::Foreground = 8 }
 Overlay has several levels. More...
 
enum  PropertyType {
  PropertyType::Unknown, PropertyType::Bool, PropertyType::Int, PropertyType::String,
  PropertyType::Double, PropertyType::Color, PropertyType::Length, PropertyType::Choice,
  PropertyType::Text, PropertyType::Currency, PropertyType::Font, PropertyType::Group,
  PropertyType::Image
}
 The type of a property More...
 
enum  PropertyState : int {
  PropertyState::None = 0x0000, PropertyState::Null = 0x0001, PropertyState::Enabled = 0x0002, PropertyState::Hidden = 0x0004 ,
  PropertyState::Editable = 0x0010, PropertyState::ReadOnly = 0x0040
}
 The state of a property. More...
 
enum  ChoiceValueType {
  ChoiceValueType::Unknown, ChoiceValueType::String, ChoiceValueType::Int, ChoiceValueType::Double,
  ChoiceValueType::Length
}
 The type of a choice value. More...
 
enum  RenderStyleBaseMode
 Basic render modes. More...
 
enum  MeasureType { MeasureType::Cartesian, MeasureType::Cylindric, MeasureType::Spherical }
 Types of position measure. More...
 
enum  Coordinates : int {
  Coordinates::X = 1 << 0, Coordinates::Y = 1 << 1, Coordinates::Z = 1 << 2, Coordinates::Rho = 1 << 3,
  Coordinates::Radius = 1 << 4, Coordinates::Phi = 1 << 5, Coordinates::Theta = 1 << 6, Coordinates::Cartesian = X | Y | Z,
  Coordinates::Cylindric = Rho | Phi | Z, Coordinates::Spherical = Radius | Phi | Theta, Coordinates::Linear = X | Y | Z | Rho | Radius, Coordinates::Angle = Phi | Theta,
  Coordinates::All = X | Y | Z | Rho | Radius | Phi | Theta
}
 Types of Coordinates. More...
 
enum  LengthUnit {
  LengthUnit::Undefined, LengthUnit::Millimeter, LengthUnit::Centimeter, LengthUnit::Inch,
  LengthUnit::Feet, LengthUnit::Meter, LengthUnit::Kilometer
}
 The length unit of the document. More...
 
enum  AcisQuality {
  AcisQuality::Lowest, AcisQuality::Low, AcisQuality::Medium, AcisQuality::High,
  AcisQuality::Highest
}
 Quality setting for acis vectorization. More...
 
enum  HorizontalTextAlignment
 Horizontal alignment of Text. More...
 
enum  VerticalTextAlignment
 Vertical alignment of Text. More...
 
enum  LightType {
  LightType::Spot, LightType::Point, LightType::Directional, LightType::Area,
  LightType::Photometric
}
 Determines the type of a light source. More...
 
enum  RenderingCategory : int { RenderingCategory::Realtime = 0x0001, RenderingCategory::Offline = 0x0002, RenderingCategory::All = 0x0003 }
 Divides renderers into performance categories. More...
 
enum  PhotometricDataFormat { PhotometricDataFormat::EULUMDAT, PhotometricDataFormat::IES }
 Format of photometric data. More...
 
enum  VectorImageFormat { VectorImageFormat::Emf, VectorImageFormat::Svg }
 Supported vector image file formats. More...
 
enum  ViewLayout {
  ViewLayout::Single, ViewLayout::OneAndTwo , ViewLayout::FourTiles, ViewLayout::OneAndThree,
  ViewLayout::HorizontalSplit, ViewLayout::VerticalSplit
}
 Determines the layout of the views. More...
 
enum  ViewCameraMode {
  ViewCameraMode::Top, ViewCameraMode::Bottom, ViewCameraMode::Left, ViewCameraMode::Right,
  ViewCameraMode::Front, ViewCameraMode::Back, ViewCameraMode::IsoNE, ViewCameraMode::IsoNW,
  ViewCameraMode::IsoSE, ViewCameraMode::IsoSW, ViewCameraMode::Perspective, ViewCameraMode::Orthographic
}
 Determines the camera mode of a view. More...
 
enum  ViewSpecificLayerVisibility { ViewSpecificLayerVisibility::Global, ViewSpecificLayerVisibility::Visible, ViewSpecificLayerVisibility::Invisible }
 Visability mode of a layer in view. More...
 
enum  EventType {
  EventType::DocumentWillClear, EventType::DocumentOpened, EventType::DocumentNew, EventType::DocumentWillSave,
  EventType::DocumentSaved, EventType::DocumentSelectionChanged, EventType::DocumentNameChanged, EventType::ApplicationWillTerminate,
  EventType::ApplicationReady, EventType::InteractionFinished, EventType::DocumentEntitiesAdded
}
 The type of a special event. More...
 
enum  SaveMode { SaveMode::Save, SaveMode::SaveCopy, SaveMode::SavePart }
 The mode used for saving the document. More...
 
enum  ArticleEntityType {
  ArticleEntityType::UnknownArticle, ArticleEntityType::SingleArticle, ArticleEntityType::Configuration, ArticleEntityType::UserArticle,
  ArticleEntityType::Placeholder
}
 The type of the article entity. More...
 
enum  ArticleGeometryMode { ArticleGeometryMode::Undefined, ArticleGeometryMode::AGM_2D, ArticleGeometryMode::AGM_3D, ArticleGeometryMode::AGM_2D3D }
 Geometry mode of an article entity describes if the geometric representation of an article is intended for 2d or 3d planning. More...
 
enum  BasketGenerationFlags : int {
  BasketGenerationFlags::SelectionOnly = 0x0001, BasketGenerationFlags::Summarize = 0x0002, BasketGenerationFlags::DirectMode = 0x0004, BasketGenerationFlags::SplitComposites = 0x0008,
  BasketGenerationFlags::PrepareCatalogImages = 0x0010, BasketGenerationFlags::PrepareGeneratedImages = 0x0020, BasketGenerationFlags::IgnoreEmptyFolders = 0x0040
}
 Flags determining how the basket is generated. More...
 
enum  BasketArtNumType {
  BasketArtNumType::Default, BasketArtNumType::Base, BasketArtNumType::Final, BasketArtNumType::VariantCode,
  BasketArtNumType::OFMLVariantCode
}
 The type of the article number. More...
 
enum  BasketArtDescrType { BasketArtDescrType::Default, BasketArtDescrType::Short, BasketArtDescrType::Long, BasketArtDescrType::Feature }
 The type of the article description. More...
 
enum  BasketTextFieldType {
  BasketTextFieldType::Undefined, BasketTextFieldType::Short, BasketTextFieldType::Long, BasketTextFieldType::Variant,
  BasketTextFieldType::Application
}
 The type of the article text field. More...
 
enum  BasketItemType {
  BasketItemType::UnknownItem, BasketItemType::Folder, BasketItemType::Article, BasketItemType::SetArticle,
  BasketItemType::UserArticle
}
 The type of the basket item More...
 

Functions

public delegate void ValueEvent (System::String^ pKey)
 Delegate to handle Events regarding the change of values. More...
 

Variables

template<typename T >
where T
 Returns all entities of given type. More...
 

Detailed Description

generic plugin namespace

Typedef Documentation

typedef System::EventHandler<DragDropEventArgs^> X3g::Plugin::DragDropEventHandler

Event handler for a drag n' drop event.

The event argument has to be of type DragDropEventArgs.

Event handler for updated geometry.

The event argument has to be of type GeometryUpdateEventArgs.

Event handler for changed layer.

The event argument has to be of type LayersChangedEventArgs.

typedef System::EventHandler<LogEventArgs^> X3g::Plugin::LogEventHandler

Event handler for LogEventArgs.

Event handler for changed material.

The event argument has to be of type MaterialChangedEventArgs.

Event handler for changed properties.

The event argument has to be of type PropertiesChangedEventArgs.

Event handler for render progress changes.

The event argument has to be of type RenderProgressChangedEventArgs.

Enumeration Type Documentation

Quality setting for acis vectorization.

Enumerator
Lowest 

lowest quality

Low 

low quality

Medium 

medium quality

High 

high quality

Highest 

highest quality

enum X3g::Plugin::AppTerminateFlags : int
strong

Flags for application termination.

Enumerator
None 

No flags set.

NoSave 

The application won't ask to save before termination even if the document has been changed.

NoCancel 

It won't be possible to cancel the termination.

Defines types how to distribute items of an arrangement.

Enumerator
ItemsCenter 

Items will be distributed with offset set to 0 and max possible gap to place all items.

ItemsOuterEdge 

Items will be distributed that there complete fit inside the base.

SymmetricInsideBase 

Items will be distributed symmetric inside base geometry.

The offset will be half of the gap.

OnNodes 

Items will be distributed on spezific points of the base geometry (e.g.

break-points).

Only available on using ArrangementType::AlongPath.

Manual 

Items will be distributed by fixed offset and gap.

Defines all possible arrangement types.

Enumerator
AlongPath 

The items will be arranged along the path.

Area 

The items will be arranged on spanned area.

Defines vertical placement of an arrangement.

Enumerator
Above 

Place items above base geometry.

Center 

Place items through base geometry.

Below 

Place items below base geometry.

ItemBased 

Place items based on local origin of item.

Determines the type of arrows of an dimension line.

Enumerator
ArchTick 

A architectural tick.

BoxBlank 

A blank box.

BoxFilled 

A filled box.

ClosedTransparent 

A transparent closed triangle.

ClosedBlank 

A blank closed triangle

ClosedFilled 

A filled closed triangle.

DatumBlank 

A blank datum triangle.

DatumFilled 

A filled datum triangle.

DotBlank 

A blank dot.

DotFilled 

A filled dot.

DotSmallFilled 

A small filled dot.

DotSmallBlank 

A small blank dot.

Integral 

An integrall.

None 

No arrow.

Oblique 

A thin oblique.

Open15 

A open triangle with 15 degree opening angle.

Open30 

A open triangle with 30 degree opening angle.

Open90 

A open triangle with 90 degree opening angle

Origin 

A blank circle.

Origin2 

A blank circle with an hole.

Determines a kind of article conversion.

Enumerator
ConvertToUserArticle 

Conversion to user article.

ExplodeArticle 

Ungroup article.

ExplodeConfiguration 

Ungroup configuration.

ExplodePlaceholder 

Ungroup placeholder.

SplitUpArticle 

Split-up article.

RemoveArticleData 

Remove article data.

The type of the article entity.

Enumerator
UnknownArticle 

An unknown article.

SingleArticle 

A single article with optional childs.

Configuration 

A group/compound of articles.

UserArticle 

A user/custom article.

Placeholder 

The entity is only a placeholder which will be replaced with the final article during the basket generation.

Geometry mode of an article entity describes if the geometric representation of an article is intended for 2d or 3d planning.

Enumerator
Undefined 

Geometry mode is undefined (e.g.

user articles).

AGM_2D 

Article entity has only two-dimensional geometry.

AGM_3D 

Article entity has only three-dimensional geometry.

AGM_2D3D 

Article entity has two- and three-dimensional geometry.

The type of the article description.

Enumerator
Default 

The short and/or long description, according to the product data's defaults.

Short 

The short description.

Long 

The long description.

Feature 

The feature description.

The type of the article number.

Enumerator
Default 

The base or final article number according to the product data defaults.

Base 

The base article number.

Final 

The final article number.

VariantCode 

The variant code.

OFMLVariantCode 

The OFML variant code.

Flags determining how the basket is generated.

Enumerator
SelectionOnly 

If set, only currently selected articles are processed, otherwise all articles in the drawing are used.

Summarize 

If set, articles with the same article number and configuration are summarized.

DirectMode 

If set, the basket is generated directly from article data in the document.

No placeholder conversion or other rules will be triggered. The summarize flag is ignored in this case.

SplitComposites 

If set, composite articles will be split up.

PrepareCatalogImages 

If set, article catalog images will be prepared.

See IBasketArticleItem::CatalogImage

PrepareGeneratedImages 

If set, generated article images will be prepared.

See IBasketArticleItem::GeneratedImage

IgnoreEmptyFolders 

If set, empty folders (and set articles) will be ignored.

The type of the basket item

Enumerator
UnknownItem 

An unknown item.

Folder 

A folder item.

Article 

An article item.

SetArticle 

A set article item.

UserArticle 

An user article item.

The type of the article text field.

Enumerator
Undefined 

Undefined text.

Short 

Short text.

Long 

Long text.

Variant 

Variant/Feature text.

Application 

Application defined text

Camera Animation Node Flags.

Enumerator
InterpolatePositionFirst 

If set, the direction/rotation will change after the position of the next node is reached else they will change together.

NormalizeDirection 

The direction (eye-center distance) will be normalized to create a more uniform rotation.

Determines the interpolation between camera animation nodes.

Enumerator
Linear 

Lines interpolation.

SplineWeak 

Weak spline interpolation.

SplineStrong 

Strong spline interpolation.

Types of camera projection.

Enumerator
Perspective 

perspective camera projection

Orthographic 

orthographic camera projection

Architectural 

architectural camera projection

Spherical 

spherical camera projection

The type of a choice value.

Enumerator
Unknown 

An unknown type.

String 

A choice of type String.

Int 

A choice of type int.

Double 

A choice of type double.

Length 

A choice which represents a length.

enum X3g::Plugin::Coordinates : int
strong

Types of Coordinates.

This enum is constructed as flags and can be combined.

Enumerator
X 

X-Direction.

Y 

Y-Direction.

Z 

Z-Direction.

Rho 

Distance on XY-Plane.

Radius 

Radius (distance to origin).

Phi 

Rotation around Z-Axis.

Theta 

Polar angle.

Cartesian 

Combination of coordinates default used by cartesian measure.

Cylindric 

Combination of coordinates default used by cylindric measure.

Spherical 

Combination of coordinates default used by spherical measure.

Linear 

Combination of all linear coordinates.

Angle 

Combination of all angle coordinates.

All 

Combination of all coordinates.

Texture Projection.

Enumerator
None 

No texture mapping.

Planar 

Maps directly to XY coordinates.

Box 

Maps to planes perpendicular to major axes.

Cylinder 

Maps to cylinder aligned with Z-axis.

Sphere 

Maps to sphere aligned with Z-axis

Determines the horizontal alignment of the dimension text.

Enumerator
Center 

The text appears centered to the dimension line.

ByFirstExtension 

The text appears beside the first extension line.

BySecondExtension 

The text appears beside the second extension line.

AboveFirstExtension 

The text appears above the first extension line.

AboveSecondExtension 

The text appears above the second extension line.

Determines the vertical alignment of the dimension text.

Enumerator
Top 

The text appears above the dimension line.

Online 

The text appears about the dimension line.

Bottom 

The text appears below the dimension line.

The document file format version.

Enumerator
Undefined 

undefined file format

AutoCad2000 

R15 file format.

AutoCad2004 

R18 file format.

AutoCad2007 

R21 file format.

AutoCad2010 

R24 file format.

AutoCad2013 

R27 file format.

AutoCad2018 

R32 file format.

The document file type.

Enumerator
Dwg 

dwg file type

Dxf 

dxf file type

Flags determining which parts of the document will get purged.

Enumerator
General 

general purging (e.g. unuesd blocks)

Materials 

purge unused materials

Layers 

purge unused layery

DimensionStyles 

purge unused dimension styles

TextStyles 

purge unused text styles

LineTypes 

purge unused line types*/

SetArticles 

purge set articles with no children*/

All 

purge all unused objects*/

Determines how the color of an entity should be computed.

Enumerator
ByColor 

The color is set directly at the entity.

ByBlock 

The color is derived from the color of the block reference, referencing a block in which the entity resides.

ByLayer 

The color is derived from the layer of the entity.

The type of a special event.

Enumerator
DocumentWillClear 

Will be send before the document will be cleared.

DocumentOpened 

Will be send after a document was opened.

DocumentNew 

Will be send after a new/empty document was created.

DocumentWillSave 

Will be send before the document will be saved.

The parameter of the event will be a SaveEventInfo instance.

DocumentSaved 

Will be send after the document was be saved.

The parameter of the event will be a SaveEventInfo instance.

DocumentSelectionChanged 

Will be send if the selection has changed.

DocumentNameChanged 

Will be send after the name of the document was changed.

ApplicationWillTerminate 

Will be send once as soon as the gui is about to close/terminate.

ApplicationReady 

Will be send once after the application was completely intialized and is ready for input.

InteractionFinished 

Sent after a tool action has been finished.

DocumentEntitiesAdded 

Sent after entities have been added to the document modelspace.

Parameter is of type EntityEventInfo.

Compatibility setting for exporting to 3ds.

Enumerator
MeshInstances 

smaller file size

Meshes 

higher compatibility with certain applications

Flags determining which kind of geometries will be collected.

Enumerator
None 

All flags disabled.

Collect2D 

Collect 2d geometries.

Collect3D 

Collect 3d geometries.

Collect2D3D 

Collect 2d and 3d geometries.

CollectInvisible 

Collect invisible geometries.

KeepDoubleSidedFaces 

Collected geometries may include double-sided faces.

By default all double-sided faces will be split into two single-sided faces, what allows to render all faces with backface culling enabled but with increased vertex, normal and texcoord count.

See Also
GeMesh::DoubleSided

Horizontal alignment of Text.

Image file formats.

Enumerator
JPEG 

Lossy compression format.

PNG 

Lossless compression format.

EXR 

High Dynamic Range (HDR) image format.

The length unit of the document.

Enumerator
Undefined 

undefined length unit

Millimeter 

millimeter length unit

Centimeter 

centimeter length unit

Inch 

inch length unit

Feet 

feet length unit

Meter 

meter length unit

Kilometer 

kilometer length unit

Determines the type of a light source.

Enumerator
Spot 

A light source which has an opening and hotspot angle.

Point 

A light source which equally emits light in all directions.

Directional 

A light source which emits light in one direction without an attenuation (e.g.

sun).

Area 

A light source which is defined by a rectangular area.

Photometric 

A light source which is defined by photometric data.

enum X3g::Plugin::LogLevel : int
strong

Defines severity of log message.

Enumerator
Fatal 

Fatal.

Error 

Error.

Warning 

Warning.

Info 

Info.

Debug 

Debug.

Determines the material type.

Enumerator
Common 

common/simple material

Glass 

glass material

Illuminant 

self-illuminating material

Types of position measure.

Enumerator
Cartesian 

Measure position with distance in X, Y and Z direction.

Cylindric 

Use a cylindric coordinate system with a distance from origin on XY-Plane, a rotation around Z-Axis and a height in Z direction.

Spherical 

Use a spherical coordinate system with two angles to describe the direction and a radius for the distance.

Orientation of the exported coordinates.

Enumerator
Y_Up 

CAD/DWG, default.

OpenGL/OFML

enum X3g::Plugin::OverlayLevel2d : int
strong

Overlay has several levels.

Higher levels are rendered over lower levels. This means that entities with higher level may occlude lower level entities.

Enumerator
Background 

Rendered over scene before 3d overlay.

Foreground 

Rendered over 3d overlay.

enum X3g::Plugin::OverlayLevel3d : int
strong

Overlay has several levels.

Higher levels are rendered over lower levels. This means that entities with higher level may occlude lower level entities.

Enumerator
InScene 

Rendered like part of the scene.

Middle 

Rendered over scene after 2d background.

Format of photometric data.

Enumerator
EULUMDAT 

EULUMDAT format.

IES 

IES format.

Image pixel formats.

Enumerator
RGB24 

integer RGB values with 24 bit per pixel

RGBA32 

integer RGBA values with 32 bit per pixel

GRAY8 

integer gray values with 8 bit per pixel

RGB96F 

floating point RGB values with 96 bit per pixel

RGBA128F 

floating point RGBA values with 128 bit per pixel

enum X3g::Plugin::PropertyState : int
strong

The state of a property.

Enumerator
None 

No flags set.

Null 

Property value is null or unassigned.

Enabled 

If not set, the property value is greyed out and read-only.

Hidden 

Property is hidden.

Editable 

Property supports user defined values.

If not set, only the values which are part of the valueset are valid.

ReadOnly 

Property value is read-only.

The type of a property

Enumerator
Unknown 

An unknown property.

Bool 

A property of type bool.

Int 

A property of type int.

String 

A property of type String.

Double 

A property of type double.

Color 

A property of type Color.

Length 

A property which represents a length.

Choice 

A choice property.

Text 

A multi-line text property.

Currency 

A property of type Currency.

Font 

A font property.

Group 

A property which groups other properties.

Image 

A property which provides an id and a bitmap stream.

enum X3g::Plugin::RenderingCategory : int
strong

Divides renderers into performance categories.

Enumerator
Realtime 

realtime rendering

Offline 

offline rendering

All 

combines all rendering categories

Basic render modes.

enum X3g::Plugin::SaveMode
strong

The mode used for saving the document.

Enumerator
Save 

The document was saved.

SaveCopy 

A copy of the document was saved.

SavePart 

Only a part of the document was saved (e.g.

the current selection)

Version of skp format.

Enumerator
Default 

Default Version.

Skp6 

skp version from 2006

Skp7 

skp version from 2008

Skp8 

skp version from 2010

Skp2013 

skp version from 2013

Skp2014 

skp version from 2014

Skp2015 

skp version from 2015

Skp2016 

skp version from 2016

Skp2017 

skp version from 2017

Skp2018 

skp version from 2018

Skp2019 

skp version from 2019

Skp2020 

skp version from 2020

Skp2021 

skp version from 2021

Determines texture type.

Enumerator
BaseColor 

base color texture

Metallic 

metallic texture

Normal 

normal texture

Roughness 

roughness texture

Supported vector image file formats.

Enumerator
Emf 

emf format

Svg 

svg format

Vertical alignment of Text.

Determines the camera mode of a view.

Enumerator
Top 

top orthographic camera

Bottom 

bottom orthographic camera

Left 

left orthographic camera

Right 

right orthographic camera

Front 

front orthographic camera

Back 

back orthographic camera

IsoNE 

isometric north-east orthographic camera

IsoNW 

isometric north-west orthographic camera

IsoSE 

isometric south-west orthographic camera

IsoSW 

isometric south-west orthographic camera

Perspective 

free perspective camera

Orthographic 

free orthographic camera

Determines the layout of the views.

Enumerator
Single 

Layout with one main view.

OneAndTwo 

Layout with one main view and two small views.

FourTiles 

Layout with four equally sized views.

OneAndThree 

Layout with one main view and three small views.

HorizontalSplit 

Layout with two horizontally splitted views.

VerticalSplit 

Layout with two vertically splitted views.

Visability mode of a layer in view.

Enumerator
Global 

layer is shown in this view, depending on its global visibility

Visible 

layer is shown in this view, regardless of its global visibility

Invisible 

layer is not shown in this view, regardless of its global visibility

Function Documentation

public delegate void X3g::Plugin::ValueEvent ( System::String^  pKey)

Delegate to handle Events regarding the change of values.

Variable Documentation

template<typename T >
where X3g::Plugin::T

Returns all entities of given type.