Anark Core SDK
Loading...
Searching...
No Matches
Anark.CoreSdkApi.Entities.SdkView Class Reference

More...

Inheritance diagram for Anark.CoreSdkApi.Entities.SdkView:
Anark.CoreSdkApi.Entities.ISdkView

Public Member Functions

 SdkView (string name, bool isPerspective, ISdkVertex3D position, ISdkVector3D upVector, ISdkVector3D viewDirection, float targetDistance, float windowSize, float fieldOfView, ISdkPlane3D[] clippingPlanes, ISdkEntityHandle[] visibleEntities)
 Construct a new user-editable view. The view will not actually exist until it has been added via the SDK API, and as such, the view's entity handle will be invalid.

Properties

ISdkEntityHandle Handle [get]
 The entity handle.
string Name [get]
 The view name.
bool IsPerspective [get]
 True if view is a perspective projection view, false if view is a parallel projection view.
ISdkVertex3D Position [get]
 Camera position.
ISdkVector3D UpVector [get]
 Camera up vector.
ISdkVector3D ViewDirection [get]
 Camera view direction.
float TargetDistance [get]
 Camera target distance.
float WindowSize [get]
 The WindowSize corresponds to the renderer zoom ball radius.
float FieldOfView [get]
 Field of View - note, this is not always available (it will be zero if not available)
ISdkVertex3D LookAtPoint [get]
 Camera "look at" point.
bool IsUserDefined [get]
 True if this is a view that was created in Anark Core. False if this is a view that was imported from a CAD model.
bool IsTopLevel [get]
 True is this is a top-level view.
ISdkPlane3D[] ClippingPlanes [get]
 A collection of the view clipping planes (if any).
ISdk3DBoundingBox CapturedSelectionBoundingBox [get]
 The bounding box of the selected occurrences at the time of the view capture.
ISdkEntityHandle[] VisibleEntities [get]
 Entities (occurrences) that are visible in the view.

Detailed Description

Constructor & Destructor Documentation

◆ SdkView()

Anark.CoreSdkApi.Entities.SdkView.SdkView ( string name,
bool isPerspective,
ISdkVertex3D position,
ISdkVector3D upVector,
ISdkVector3D viewDirection,
float targetDistance,
float windowSize,
float fieldOfView,
ISdkPlane3D[] clippingPlanes,
ISdkEntityHandle[] visibleEntities )
inline

Construct a new user-editable view. The view will not actually exist until it has been added via the SDK API, and as such, the view's entity handle will be invalid.

Parameters
nameThe name of the view. This will be displayed in the UI and also published with the view.
isPerspectiveSet this to true if this is a perspective view or false if the projection mode is parallel.
positionCamera position
upVectorCamera up vector
viewDirectionCamera view direction
targetDistanceCamera target distance
windowSizeThe WindowSize corresponds to the renderer zoom ball radius.
fieldOfViewField of View - note, this is not always available (set to zero if not available)
clippingPlanesA collection of the view clipping planes (if any).
visibleEntitiesA collection of entities that are to be shown when the view is active.

Property Documentation

◆ CapturedSelectionBoundingBox

ISdk3DBoundingBox Anark.CoreSdkApi.Entities.SdkView.CapturedSelectionBoundingBox
get

The bounding box of the selected occurrences at the time of the view capture.

Implements Anark.CoreSdkApi.Entities.ISdkView.

◆ ClippingPlanes

ISdkPlane3D [] Anark.CoreSdkApi.Entities.SdkView.ClippingPlanes
get

A collection of the view clipping planes (if any).

Implements Anark.CoreSdkApi.Entities.ISdkView.

◆ FieldOfView

float Anark.CoreSdkApi.Entities.SdkView.FieldOfView
get

Field of View - note, this is not always available (it will be zero if not available)

Implements Anark.CoreSdkApi.Entities.ISdkView.

◆ Handle

ISdkEntityHandle Anark.CoreSdkApi.Entities.SdkView.Handle
get

The entity handle.

Implements Anark.CoreSdkApi.Entities.ISdkView.

◆ IsPerspective

bool Anark.CoreSdkApi.Entities.SdkView.IsPerspective
get

True if view is a perspective projection view, false if view is a parallel projection view.

Implements Anark.CoreSdkApi.Entities.ISdkView.

◆ IsTopLevel

bool Anark.CoreSdkApi.Entities.SdkView.IsTopLevel
get

True is this is a top-level view.

Implements Anark.CoreSdkApi.Entities.ISdkView.

◆ IsUserDefined

bool Anark.CoreSdkApi.Entities.SdkView.IsUserDefined
get

True if this is a view that was created in Anark Core. False if this is a view that was imported from a CAD model.

Implements Anark.CoreSdkApi.Entities.ISdkView.

◆ LookAtPoint

ISdkVertex3D Anark.CoreSdkApi.Entities.SdkView.LookAtPoint
get

Camera "look at" point.

Implements Anark.CoreSdkApi.Entities.ISdkView.

◆ Name

string Anark.CoreSdkApi.Entities.SdkView.Name
get

The view name.

Implements Anark.CoreSdkApi.Entities.ISdkView.

◆ Position

ISdkVertex3D Anark.CoreSdkApi.Entities.SdkView.Position
get

Camera position.

Implements Anark.CoreSdkApi.Entities.ISdkView.

◆ TargetDistance

float Anark.CoreSdkApi.Entities.SdkView.TargetDistance
get

Camera target distance.

Implements Anark.CoreSdkApi.Entities.ISdkView.

◆ UpVector

ISdkVector3D Anark.CoreSdkApi.Entities.SdkView.UpVector
get

Camera up vector.

Implements Anark.CoreSdkApi.Entities.ISdkView.

◆ ViewDirection

ISdkVector3D Anark.CoreSdkApi.Entities.SdkView.ViewDirection
get

Camera view direction.

Implements Anark.CoreSdkApi.Entities.ISdkView.

◆ VisibleEntities

ISdkEntityHandle [] Anark.CoreSdkApi.Entities.SdkView.VisibleEntities
get

Entities (occurrences) that are visible in the view.

Implements Anark.CoreSdkApi.Entities.ISdkView.

◆ WindowSize

float Anark.CoreSdkApi.Entities.SdkView.WindowSize
get

The WindowSize corresponds to the renderer zoom ball radius.

Implements Anark.CoreSdkApi.Entities.ISdkView.