Epok Engine

EPOK RUNTIME

Camera Rig

camera_rig.hpp · camera selection, projection and shared render resources

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Module

camera selection, projection and shared render resources.

Header
camera_rig.hpp
Include
#include "camera_rig.hpp"
Stability
Epok runtime API

Include this module

C++ include
#include "camera_rig.hpp"

Types

ArmStateStruct declared by the camera-rig module for camera selection, projection and shared render resources.StructArmTuningStruct declared by the camera-rig module for camera selection, projection and shared render resources.StructCameraOrbitInputComponentClass declared by the camera-rig module for camera selection, projection and shared render resources.ClassCameraRig3DClass declared by the camera-rig module for camera selection, projection and shared render resources.ClassCameraRigSampleStruct declared by the camera-rig module for camera selection, projection and shared render resources.StructCameraRigStatusEnum declared by the camera-rig module for camera selection, projection and shared render resources.EnumFirstPersonCameraClass declared by the camera-rig module for camera selection, projection and shared render resources.ClassIsometricCameraClass declared by the camera-rig module for camera selection, projection and shared render resources.ClassSpringArmComponentClass declared by the camera-rig module for camera selection, projection and shared render resources.ClassSpringArmSampleStruct declared by the camera-rig module for camera selection, projection and shared render resources.StructThirdPersonCameraClass declared by the camera-rig module for camera selection, projection and shared render resources.ClassTopDownCameraClass declared by the camera-rig module for camera selection, projection and shared render resources.ClassWorldQueriesStruct declared by the camera-rig module for camera selection, projection and shared render resources.Struct

Functions and methods

add_lookAdds look as part of camera selection, projection and shared render resources.Methodbegin_playBegins play as part of camera selection, projection and shared render resources.Methodbegin_playBegins play as part of camera selection, projection and shared render resources.MethodboomPerforms `boom` as part of camera selection, projection and shared render resources.FunctionboundedPerforms `bounded` as part of camera selection, projection and shared render resources.Functioncalculate_viewPerforms `calculate view` as part of camera selection, projection and shared render resources.MethodcastPerforms `cast` as part of camera selection, projection and shared render resources.Methodclass_idPerforms `class id` as part of camera selection, projection and shared render resources.Methodclass_idPerforms `class id` as part of camera selection, projection and shared render resources.Methodclass_idPerforms `class id` as part of camera selection, projection and shared render resources.Methodclass_idPerforms `class id` as part of camera selection, projection and shared render resources.Methodclass_idPerforms `class id` as part of camera selection, projection and shared render resources.Methodclass_idPerforms `class id` as part of camera selection, projection and shared render resources.Methodclass_idPerforms `class id` as part of camera selection, projection and shared render resources.Methodend_playEnds play as part of camera selection, projection and shared render resources.Methodend_playEnds play as part of camera selection, projection and shared render resources.MethodFirstPersonCameraConstructs `epok::FirstPersonCamera` for camera selection, projection and shared render resources.constructorIsometricCameraConstructs `epok::IsometricCamera` for camera selection, projection and shared render resources.constructormake_activePerforms `make active` as part of camera selection, projection and shared render resources.Methodon_disablePerforms `on disable` as part of camera selection, projection and shared render resources.Methodon_disablePerforms `on disable` as part of camera selection, projection and shared render resources.Methodon_enablePerforms `on enable` as part of camera selection, projection and shared render resources.MethodrefreshPerforms `refresh` as part of camera selection, projection and shared render resources.MethodresetResets reset as part of camera selection, projection and shared render resources.MethodsamplePerforms `sample` as part of camera selection, projection and shared render resources.MethodsamplePerforms `sample` as part of camera selection, projection and shared render resources.Methodset_anglesSets angles as part of camera selection, projection and shared render resources.MethodsnapPerforms `snap` as part of camera selection, projection and shared render resources.MethodsolvePerforms `solve` as part of camera selection, projection and shared render resources.FunctionsolvePerforms `solve` as part of camera selection, projection and shared render resources.Methodsolve_sharedPerforms `solve shared` as part of camera selection, projection and shared render resources.MethodtickPerforms `tick` as part of camera selection, projection and shared render resources.MethodtickPerforms `tick` as part of camera selection, projection and shared render resources.MethodTopDownCameraConstructs `epok::TopDownCamera` for camera selection, projection and shared render resources.constructorupdateUpdates update as part of camera selection, projection and shared render resources.Methodview_updatedPerforms `view updated` as part of camera selection, projection and shared render resources.Method

Fields, variables and values

adaptive_pull_inExposes `adaptive_pull_in` on `epok::camera_rig::ArmTuning` for camera selection, projection and shared render resources.Fieldadaptive_pull_inExposes `adaptive_pull_in` on `epok::SpringArmComponent` for camera selection, projection and shared render resources.FieldAppliedNamed value `Applied` in `epok::CameraRigStatus`.Enum valueautomatic_tickExposes `automatic_tick` on `epok::CameraRig3D` for camera selection, projection and shared render resources.FieldblockedExposes `blocked` on `epok::CameraRigSample` for camera selection, projection and shared render resources.FieldblockedExposes `blocked` on `epok::SpringArmSample` for camera selection, projection and shared render resources.FieldboomExposes `boom` on `epok::ThirdPersonCamera` for camera selection, projection and shared render resources.FieldBusyNamed value `Busy` in `epok::CameraRigStatus`.Enum valuecameraExposes `camera` on `epok::CameraRig3D` for camera selection, projection and shared render resources.Fieldcollision_enabledExposes `collision_enabled` on `epok::camera_rig::ArmTuning` for camera selection, projection and shared render resources.Fieldcollision_enabledExposes `collision_enabled` on `epok::SpringArmComponent` for camera selection, projection and shared render resources.Fieldcollision_maskExposes `collision_mask` on `epok::SpringArmComponent` for camera selection, projection and shared render resources.FielddistanceExposes `distance` on `epok::CameraRig3D` for camera selection, projection and shared render resources.FielddistanceExposes `distance` on `epok::CameraRigSample` for camera selection, projection and shared render resources.FieldenabledExposes `enabled` on `epok::CameraOrbitInputComponent` for camera selection, projection and shared render resources.Fieldextension_responseExposes `extension_response` on `epok::camera_rig::ArmTuning` for camera selection, projection and shared render resources.Fieldextension_responseExposes `extension_response` on `epok::SpringArmComponent` for camera selection, projection and shared render resources.Fieldfollow_responseExposes `follow_response` on `epok::CameraRig3D` for camera selection, projection and shared render resources.Fieldfollow_targetExposes `follow_target` on `epok::CameraRig3D` for camera selection, projection and shared render resources.FieldfractionExposes `fraction` on `epok::camera_rig::ArmState` for camera selection, projection and shared render resources.FieldfractionExposes `fraction` on `epok::SpringArmSample` for camera selection, projection and shared render resources.FieldinitializedExposes `initialized` on `epok::camera_rig::ArmState` for camera selection, projection and shared render resources.FieldInvalidArmNamed value `InvalidArm` in `epok::CameraRigStatus`.Enum valueInvalidConfigurationNamed value `InvalidConfiguration` in `epok::CameraRigStatus`.Enum valueInvalidOwnerNamed value `InvalidOwner` in `epok::CameraRigStatus`.Enum valueInvalidTargetNamed value `InvalidTarget` in `epok::CameraRigStatus`.Enum valuemaskExposes `mask` on `epok::camera_rig::ArmTuning` for camera selection, projection and shared render resources.Fieldminimum_fractionExposes `minimum_fraction` on `epok::camera_rig::ArmTuning` for camera selection, projection and shared render resources.Fieldminimum_fractionExposes `minimum_fraction` on `epok::SpringArmComponent` for camera selection, projection and shared render resources.FieldNoStepNamed value `NoStep` in `epok::CameraRigStatus`.Enum valueoffset_xExposes `offset_x` on `epok::CameraRig3D` for camera selection, projection and shared render resources.Fieldoffset_yExposes `offset_y` on `epok::CameraRig3D` for camera selection, projection and shared render resources.Fieldoffset_zExposes `offset_z` on `epok::CameraRig3D` for camera selection, projection and shared render resources.Fieldonly_when_currentExposes `only_when_current` on `epok::CameraOrbitInputComponent` for camera selection, projection and shared render resources.FieldpitchExposes `pitch` on `epok::CameraRig3D` for camera selection, projection and shared render resources.FieldpitchExposes `pitch` on `epok::CameraRigSample` for camera selection, projection and shared render resources.Fieldpitch_maxExposes `pitch_max` on `epok::CameraRig3D` for camera selection, projection and shared render resources.Fieldpitch_minExposes `pitch_min` on `epok::CameraRig3D` for camera selection, projection and shared render resources.Fieldpitch_rateExposes `pitch_rate` on `epok::CameraOrbitInputComponent` for camera selection, projection and shared render resources.FieldportExposes `port` on `epok::CameraOrbitInputComponent` for camera selection, projection and shared render resources.FieldpositionExposes `position` on `epok::CameraRigSample` for camera selection, projection and shared render resources.FieldpositionExposes `position` on `epok::SpringArmSample` for camera selection, projection and shared render resources.Fieldpull_inExposes `pull_in` on `epok::camera_rig::ArmTuning` for camera selection, projection and shared render resources.Fieldpull_inExposes `pull_in` on `epok::SpringArmComponent` for camera selection, projection and shared render resources.FieldrigExposes `rig` on `epok::CameraOrbitInputComponent` for camera selection, projection and shared render resources.FieldrollExposes `roll` on `epok::CameraRigSample` for camera selection, projection and shared render resources.Fieldspring_armExposes `spring_arm` on `epok::CameraRig3D` for camera selection, projection and shared render resources.Fieldstatic_class_idExposes `static_class_id` on `epok::CameraOrbitInputComponent` for camera selection, projection and shared render resources.Variablestatic_class_idExposes `static_class_id` on `epok::CameraRig3D` for camera selection, projection and shared render resources.Variablestatic_class_idExposes `static_class_id` on `epok::FirstPersonCamera` for camera selection, projection and shared render resources.Variablestatic_class_idExposes `static_class_id` on `epok::IsometricCamera` for camera selection, projection and shared render resources.Variablestatic_class_idExposes `static_class_id` on `epok::SpringArmComponent` for camera selection, projection and shared render resources.Variablestatic_class_idExposes `static_class_id` on `epok::ThirdPersonCamera` for camera selection, projection and shared render resources.Variablestatic_class_idExposes `static_class_id` on `epok::TopDownCamera` for camera selection, projection and shared render resources.VariablestatusExposes `status` on `epok::CameraRigSample` for camera selection, projection and shared render resources.FieldstatusExposes `status` on `epok::SpringArmSample` for camera selection, projection and shared render resources.FieldtargetExposes `target` on `epok::CameraRig3D` for camera selection, projection and shared render resources.Fieldtick_groupExposes `tick_group` on `epok::CameraOrbitInputComponent` for camera selection, projection and shared render resources.Variabletick_groupExposes `tick_group` on `epok::CameraRig3D` for camera selection, projection and shared render resources.VariableyawExposes `yaw` on `epok::CameraRig3D` for camera selection, projection and shared render resources.FieldyawExposes `yaw` on `epok::CameraRigSample` for camera selection, projection and shared render resources.Fieldyaw_rateExposes `yaw_rate` on `epok::CameraOrbitInputComponent` for camera selection, projection and shared render resources.Field