Interface IVisualization3D
Gives access to 3D visualization.
Namespace: TopSolid.Kernel.Automating
Assembly: cs.temp.dll.dll
Syntax
[AvailableSinceVersion(7, 7, 0, 0)]
public interface IVisualization3DRemarks
This interface is available since v7.7.
Methods
GetActiveView(DocumentId)
Gets the active graphic view of a document.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
int GetActiveView(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Identifier of the active graphic view of the document. |
Remarks
This method is available since v7.7.
GetBackCamera(DocumentId)
Gets the back camera entity of a document.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
ElementId GetBackCamera(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the back camera entity found. |
Remarks
This method is available since v7.7.
GetBottomCamera(DocumentId)
Gets the bottom camera entity of a document.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
ElementId GetBottomCamera(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the bottom camera entity found. |
Remarks
This method is available since v7.7.
GetCameraDefinition(ElementId, out Point3D, out Direction3D, out Direction3D, out Double, out Double)
Gets the definition of a camera entity.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
void GetCameraDefinition(ElementId inElementId, out Point3D outEyePosition, out Direction3D outLookAtDirection, out Direction3D outUpDirection, out double outFieldAngle, out double outFieldRadius)Parameters
| Type | Name | Description |
|---|---|---|
| ElementId | inElementId | Identifier of the camera entity to analyze. |
| Point3D | outEyePosition | Eye position. |
| Direction3D | outLookAtDirection | |
| Direction3D | outUpDirection | |
| System.Double | outFieldAngle | Field angle for perspective projection, or 0 if orthographic projection. |
| System.Double | outFieldRadius | Field radius for orthographic projection, or distance between camera origin and projection plane if perspective projection. |
Remarks
This method is available since v7.7.
GetCameras(DocumentId)
Gets the cameras entities that are in the cameras folder of a document.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
List<ElementId> GetCameras(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| List<ElementId> | Cameras entities found. |
Remarks
This method is available since v7.7.
GetConicalCamera(DocumentId)
Gets the conical camera entity of a document.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
ElementId GetConicalCamera(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the conical camera entity found. |
Remarks
This method is available since v7.7.
GetDefaultDocumentPreviewParameters(DocumentId, out Int32, out ElementId, out RenderMode)
Gets the document's default preview parameters.
Declaration
[AvailableSinceVersion(7, 14, 300, 140)]
void GetDefaultDocumentPreviewParameters(DocumentId inDocumentId, out int outSizeOfPreview, out ElementId outPreviewCamera, out RenderMode outPreviewRenderMode)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
| System.Int32 | outSizeOfPreview | Size of the preview. |
| ElementId | outPreviewCamera | Preview camera if the document is of Geometric type. |
| RenderMode | outPreviewRenderMode | Preview render mode if the document is of Geometric type. |
Remarks
This method is available since v7.14.300.140.
GetDocumentPreviewMode(DocumentId)
Gets the document preview mode.
Declaration
[AvailableSinceVersion(7, 14, 300, 140)]
PreviewMode GetDocumentPreviewMode(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| PreviewMode | Preview mode of the document. |
Remarks
This method is available since v7.14.300.140.
GetFrontCamera(DocumentId)
Gets the front camera entity of a document.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
ElementId GetFrontCamera(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the front camera entity found. |
Remarks
This method is available since v7.7.
GetIsometricCamera(DocumentId)
Gets the isometric camera entity of a document.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
ElementId GetIsometricCamera(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the isometric camera entity found. |
Remarks
This method is available since v7.7.
GetLeftCamera(DocumentId)
Gets the left camera entity of a document.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
ElementId GetLeftCamera(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the left camera entity found. |
Remarks
This method is available since v7.7.
GetPerspectiveCamera(DocumentId)
Gets the perspective camera entity of a document.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
ElementId GetPerspectiveCamera(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the perspective camera entity found. |
Remarks
This method is available since v7.7.
GetRightCamera(DocumentId)
Gets the right camera entity of a document.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
ElementId GetRightCamera(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the right camera entity found. |
Remarks
This method is available since v7.7.
GetTopCamera(DocumentId)
Gets the top camera entity of a document.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
ElementId GetTopCamera(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| ElementId | Identifier of the top camera entity found. |
Remarks
This method is available since v7.7.
GetViewCamera(DocumentId, Int32, out Point3D, out Direction3D, out Direction3D, out Double, out Double)
Gets the camera of a graphic view of a document.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
void GetViewCamera(DocumentId inDocumentId, int inViewId, out Point3D outEyePosition, out Direction3D outLookAtDirection, out Direction3D outUpDirection, out double outFieldAngle, out double outFieldRadius)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
| System.Int32 | inViewId | Identifier of the graphic view to analyze. |
| Point3D | outEyePosition | Position of the eye. |
| Direction3D | outLookAtDirection | Eye looking direction. |
| Direction3D | outUpDirection | Vertical upwards direction. |
| System.Double | outFieldAngle | Field angle for perspective projection, or 0 if orthographic projection. |
| System.Double | outFieldRadius | Field radius for orthographic projection, or distance between camera origin and projection plane if perspective projection. |
Remarks
This method is available since v7.7.
GetViewCount(DocumentId)
Gets the number of graphic views of a document.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
int GetViewCount(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Number of graphic views of the document. |
Remarks
This method is available since v7.7.
GetViewRectangle(DocumentId, Int32, out Int32, out Int32, out Int32, out Int32)
Gets the screen rectangle of the graphic view of a document.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
void GetViewRectangle(DocumentId inDocumentId, int inViewId, out int outXMin, out int outXMax, out int outYMin, out int outYMax)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
| System.Int32 | inViewId | Identifier of the graphic view to analyze. |
| System.Int32 | outXMin | Left side coordinate. |
| System.Int32 | outXMax | Right side coordinate. |
| System.Int32 | outYMin | Bottom side coordinate. |
| System.Int32 | outYMax | Top side coordinate. |
Remarks
Rectangle is expressed in GDI screen coordinates (origin at top-left of screen).
This method is available since v7.7.
GetViewRenderMode(DocumentId, Int32)
Gets the render mode of a graphic view of a document.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
RenderMode GetViewRenderMode(DocumentId inDocumentId, int inViewId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
| System.Int32 | inViewId | Identifier of the graphic view to analyze. |
Returns
| Type | Description |
|---|---|
| RenderMode | View render mode. |
Remarks
This method is available since v7.7.
GetViews(DocumentId)
Gets the graphic views of a document.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
List<int> GetViews(DocumentId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to analyze. |
Returns
| Type | Description |
|---|---|
| List<System.Int32> | Identifiers of the graphic views of the document. |
Remarks
This method is available since v7.7.
RedrawView(DocumentId, Int32)
Redraws a graphic view of a document.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
void RedrawView(DocumentId inDocumentId, int inViewId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| System.Int32 | inViewId | Identifier of the graphic view to redraw. |
Remarks
This method is available since v7.7.
SetActiveView(DocumentId, Int32)
Sets the active graphic view of a document.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
void SetActiveView(DocumentId inDocumentId, int inViewId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| System.Int32 | inViewId | Identifier of the active graphic view of the document. |
Remarks
This method is available since v7.7.
SetDefaultDocumentPreviewParameters(DocumentId, Int32, ElementId, RenderMode)
Sets the document's default preview parameters.
Declaration
[AvailableSinceVersion(7, 14, 300, 140)]
void SetDefaultDocumentPreviewParameters(DocumentId inDocumentId, int inSizeOfPreview, ElementId inPreviewCamera, RenderMode inPreviewRenderMode)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| System.Int32 | inSizeOfPreview | Size of the preview. |
| ElementId | inPreviewCamera | Preview camera. |
| RenderMode | inPreviewRenderMode | Preview render mode. Only Realistic, RealisticWithEdges and GouraudWithEdges are available for this method. |
Remarks
This method is available since v7.14.300.140.
SetStandardCamerasDefinitions(DocumentId, Direction3D, Direction3D)
Sets the definitions of the standard cameras entities.
Declaration
[AvailableSinceVersion(7, 11, 0, 0)]
void SetStandardCamerasDefinitions(DocumentId inDocumentId, Direction3D inHorizontalDirection, Direction3D inVerticalDirection)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| Direction3D | inHorizontalDirection | Horizontal direction. |
| Direction3D | inVerticalDirection | Vertical direction. |
Remarks
The standard "Top Camera" will be set so that when applied to a view the inHorizontalDirection is actually horizontal
on the screen oriented from left to right, and the inVerticalDirection is normal to the screen oriented towards the user.
The other standard cameras will be set accordingly.
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.11.
SetViewCamera(DocumentId, Int32, Point3D, Direction3D, Direction3D, Double, Double)
Sets the camera of a graphic view of a document.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
void SetViewCamera(DocumentId inDocumentId, int inViewId, Point3D inEyePosition, Direction3D inLookAtDirection, Direction3D inUpDirection, double inFieldAngle, double inFieldRadius)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| System.Int32 | inViewId | Identifier of the graphic view to modify. |
| Point3D | inEyePosition | Position of the eye. |
| Direction3D | inLookAtDirection | Eye looking direction. |
| Direction3D | inUpDirection | Vertical upwards direction. |
| System.Double | inFieldAngle | Field angle for perspective projection, or 0 if orthographic projection. |
| System.Double | inFieldRadius | Field radius for orthographic projection, or distance between camera origin and projection plane if perspective projection. |
Remarks
StartModification(String, Boolean) and EnsureIsDirty(ref DocumentId) must be called before calling this method.
This method is available since v7.7.
SetViewRenderMode(DocumentId, Int32, RenderMode)
Sets the render mode of a graphic view of a document.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
void SetViewRenderMode(DocumentId inDocumentId, int inViewId, RenderMode inRenderMode)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| System.Int32 | inViewId | Identifier of the graphic view to modify. |
| RenderMode | inRenderMode | View render mode. |
Remarks
This method is available since v7.7.
ZoomToFitView(DocumentId, Int32)
Performs a "Zoom to Fit" on a graphic view of a document.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
void ZoomToFitView(DocumentId inDocumentId, int inViewId)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentId | inDocumentId | Identifier of the document to modify. |
| System.Int32 | inViewId | Identifier of the graphic view to modify. |
Remarks
This method is available since v7.7.