wdpapi
Version:
51WORLD WdpApi is a set of programming interfaces developed by JavaScript that is responsible for negotiating between web pages and cloud rendering platforms. Supported by 51Cloud rendering platform, it enables the users to create any HTML5 UI element on
224 lines (223 loc) • 6.57 kB
TypeScript
import { ICameraUpdateOpt, CameraControlType, CameraFocusType, CameraFollowType, SetCameraLimitType, CameraRotateType, IFocusToAllEntities, ICameraPose, IResetCameraPose, ISetCameraLockLimit, IFocusToNodes, ICameraMoveBasic, ICameraStepMove, ICameraStepRotate, ISetCameraSpeed, ISetCameraAnimation } from '../modules/common/interface/camera';
/**
* @public
* @class CameraControllerValidate
*/
export declare class CameraControllerValidate {
/**
* @public
* @function validateFocusToNodes
* @param {Partial<IFocusToNodes>} opt
* @returns {void}
*/
validateFocusToNodes(opt: Partial<IFocusToNodes>): void;
/**
* @public
* @function validateResetCameraLimit
* @param {string} state
* @returns {void}
*/
validateResetCameraLimit(state: string): void;
/**
* @public
* @function validateSetCameraLockLimit
* @param {Partial<ISetCameraLockLimit>} opt
* @returns {void}
*/
validateSetCameraLockLimit(opt: Partial<ISetCameraLockLimit>): void;
/**
* @public
* @function validateSetCameraLimit
* @param {Partial<SetCameraLimitType>} opt
* @returns {void}
*/
validateSetCameraLimit(opt: Partial<SetCameraLimitType>): void;
/**
* @public
* @function validateResetCameraPose
* @param {Partial<IResetCameraPose>} opt
* @returns {void}
*/
validateResetCameraPose(opt: Partial<IResetCameraPose>): void;
/**
* @public
* @function validateSetCameraPose
* @param {Partial<ICameraPose>} opt
* @returns {void}
*/
validateSetCameraPose(opt: Partial<ICameraPose>): void;
/**
* @public
* @function validateSetCameraMode
* @param {string} controlMode
* @returns {void}
*/
validateSetCameraMode(controlMode: string): void;
/**
* @public
* @function validateUpdateCamera
* @param {ICameraUpdateOpt} opt
* @returns {void}
*/
validateUpdateCamera(opt: ICameraUpdateOpt): void;
/**
* @public
* @function validateFlyTo
* @param {CameraControlType} opt
* @returns {void}
*/
validateFlyTo(opt: CameraControlType): void;
/**
* @public
* @function validateMove
* @param {CameraRotateType} opt
* @returns {void}
*/
validateMove(opt: CameraRotateType): void;
/**
* @public
* @function validateFocus
* @param {CameraFocusType} opt
* @returns {void}
*/
validateFocus(opt: CameraFocusType): void;
/**
* @public
* @function validateFollow
* @param {CameraFollowType} opt
* @returns {void}
*/
validateFollow(opt: CameraFollowType): void;
/**
* @public
* @function validateRotate
* @param {CameraRotateType} opt
* @returns {void}
*/
validateRotate(opt: CameraRotateType): void;
/**
* @public
* @function validateAround
* @param {CameraRotateType} opt
* @returns {void}
*/
validateAround(opt: CameraRotateType): void;
/**
* @public
* @function validatePlayCameraRoam
* @param {Record<string, any>} obj
* @param {{state?: string, progressRatio?: number, speedRatio?: number, bReverse?: boolean}} opt
* @returns {void}
*/
validatePlayCameraRoam(obj: Record<string, any>, opt?: {
state?: string;
progressRatio?: number;
speedRatio?: number;
bReverse?: boolean;
bEnableRotatingOnPause?: boolean;
bEnableZoomingOnPause?: boolean;
}): void;
/**
* @public
* @function validateGetCameraRoamingInfo
* @param {Record<string, any>} obj
* @returns {void}
*/
validateGetCameraRoamingInfo(obj: Record<string, any>): void;
/**
* @public
* @function validatePlayRoam
* @param {Record<string, any>} obj
* @param {{progressRatio?: number, speedRatio?: number, bReverse?: boolean}} opt
* @returns {void}
*/
validatePlayRoam(obj: Record<string, any>, opt?: {
progressRatio?: number;
speedRatio?: number;
bReverse?: boolean;
}): void;
/**
* @public
* @function validatePauseRoam
* @param {Record<string, any>} obj
* @param {{bEnableRotatingOnPause?: boolean, bEnableZoomingOnPause?: boolean}} opt
* @returns {void}
*/
validatePauseRoam(opt?: {
bEnableRotatingOnPause?: boolean;
bEnableZoomingOnPause?: boolean;
}): void;
/**
* @public
* @function validateApply
* @param {Record<string, any>} camera
* @param {number} flyTime (default value is 1)
* @returns {void}
*/
validateApply(camera: Record<string, any>, flyTime?: number): void;
/**
* @public
* @function validateFocusByCustomId
* @param {Array<string>} cids
* @param {CameraFocusType} opt
* @returns {void}
*/
validateFocusByCustomId(cids: Array<string>, opt: CameraFocusType): void;
/**
* @public
* @function validateFocusByEntityName
* @param {Array<string>} entityNames
* @param {CameraFocusType} opt
* @returns {void}
*/
validateFocusByEntityName(entityNames: Array<string>, opt: CameraFocusType): void;
/**
* @public
* @function validateFocusToAll
* @param {IFocusToAllEntities} opt
* @returns {void}
*/
validateFocusToAll(opt?: IFocusToAllEntities): void;
/**
* @public
* @function validateCameraStepMove
* @param {ICameraStepMove} opt
* @returns {void}
*/
validateCameraStepMove(opt: ICameraStepMove): void;
/**
* @public
* @function validateCameraStepRotate
* @param {ICameraStepRotate} opt
* @returns {void}
*/
validateCameraStepRotate(opt: ICameraStepRotate): void;
/**
* @public
* @function validateCameraStepZoom
* @param {ICameraMoveBasic} opt
* @returns {void}
*/
validateCameraStepZoom(opt: ICameraMoveBasic): void;
/**
* @public
* @function validateSetCameraSpeed
* @param {ISetCameraSpeed} opt
* @returns {void}
*/
validateSetCameraSpeed(opt: ISetCameraSpeed): void;
/**
* @public
* @function validateSetCameraAnimation
* @param {ISetCameraAnimation} opt
* @returns {void}
*/
validateSetCameraAnimation(opt: ISetCameraAnimation): void;
/**
* @public
* @function validateToggleCameraSelfRotate
* @param {boolean} bSelfRotate
* @returns {void}
*/
validateToggleCameraSelfRotate(bSelfRotate: boolean): void;
}