FI3DHClipPlaneAPI Class Reference

instant3Dhub: FI3DHClipPlaneAPI Class Reference
instant3Dhub
FI3DHClipPlaneAPI Class Referenceabstract

#include "I3DHConnectorAPI.h"

Detailed Description

ClipPlaneAPI owned by the instant3Dhub AI3DHConnector.

See also
ClipPlane API for a general overview of how clipping works using the Instant3Dhub plugin.

Public Member Functions

Advanced API

The advanced API allows you to manage multiple clip planes.

virtual void CreateClipPlane (const FI3DHClipPlaneProperties &Properties, TUniqueFunction< void(int32 ClipPlaneId, EI3DHErrorCode ErrorCode)> OnComplete)=0
 
virtual void ChangeClipPlane (int32 ClipPlaneId, const FI3DHClipPlaneProperties &Properties, TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0
 
virtual void GetClipPlaneProperties (int32 ClipPlaneId, TUniqueFunction< void(const FI3DHClipPlaneProperties &Properties, EI3DHErrorCode ErrorCode)> OnComplete)=0
 
virtual void RemoveClipPlane (int32 ClipPlaneId, TUniqueFunction< void(EI3DHRemoveState RemoveState, EI3DHErrorCode ErrorCode)> OnComplete)=0
 
virtual TArray< int32 > GetClipPlanes ()=0
 
virtual AActorFindClipPlaneActor (int32 ClipPlaneId)=0
 
Basic API

The basic API allows you to manage a single clip plane only. One of the regular clip planes will be designated the main clip plane. Usually this is the first clip plane created by webvis. If there is no main clip plane, when you call FI3DHClipPlaneAPI::EnableMainClipPlane, then a new clip plane is automatically created for you.

virtual void EnableMainClipPlane (TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0
 
virtual void DisableMainClipPlane (TUniqueFunction< void(EI3DHErrorCode ErrorCode)> OnComplete)=0
 
virtual AActorGetMainClipPlaneActor ()=0
 

The documentation for this class was generated from the following file: