Component:InteractiveCameraControl

From Resonite Wiki
Revision as of 20:10, 12 March 2025 by 989onan (talk | contribs) (add info)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Component image 
File:InteractiveCameraControlComponent.png
Interactive Camera Control component as seen in the Scene Inspector

See Camera.

Fields

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
_canvas Canvas The canvas being used to show settings.
_panel LegacyPanel The legacy panel being used as a base to interact with the settings.
FieldOfView Float The field of view for the camera. The default is 60.
AnglePosition Float The rotation around the subject. The default is 0.00.
Distance Float The distance from the camera and the subject. The default is 1.50.
HeightOffset Float The height for this camera to be at. The default is 0.
FirstPersonPitch Float Adjust the up and down angle of the camera when the camera is in Smooth POV mode. The default is 5.00.
FirstPersonRoll Float Adjust the rotation of the camera when the camera is in Smooth POV mode. The default is 0.00.
FirstPersonOffset Float Adjust the forward offset of the camera when the camera is in Smooth POV mode. The default is 0.02.
FramingViewportPosition Float2 How to shift the camera framing like an offset.
Mirror Bool Mirrors the camera view.
GroupDetectionRadius Float This is the range to include users into a group photo and to have the camera focus all of them as the subject.
GroupLeaveBoundary Float This is the far range to exclude other users from the group range.
PositionSmoothSpeed Float How fast or slow the camera position movement should be smoothed.
AngleSmoothSpeed Float The smoothness of how fast this camera turns and rotates to adjust for movement, to focus towards the subject.
FramingSmoothSpeed Float This is how fast the camera will move in frame towards the subject.
InterpolateBetweenAnchors Bool This allows the camera to smoothly go between anchor positions and rotations. If this is off, the camera will instantly go to the anchor instead of being smooth.
AnchorInterpolationSpeed Float How fast to move between anchors.
AnchorLinearInterpolation Bool Whether the camera should move between anchors in a linear speed fashion.
Mode CameraPositioningMode How the camera should position itself.
FramingTargetOverride String Frame only the user with this username.
CameraOperators direct SyncFieldList`1<String> A list of people who can interact with the camera.
GroupIncludeUsers direct SyncFieldList`1<String> A list of users to force include into the target group.
GroupExcludeUsers direct SyncFieldList`1<String> A list of users to force exclude from the target group.
RenderForEveryone Bool This shows the preview to any user that is looking at the preview window on the camera.
AnyoneCanInteract Bool This allows any user to interact with the your camera.
RenderPrivateUI Bool This shows the Camera Controls Panel to be shown in the preview and pictures.
MotionBlur Bool This enables the camera to have motion blue as it moves.
ScreenSpaceReflections Bool This shows screen space reflection through the preview and pictures.
SpawnPhotoInWorld Bool This will spawn the photo in to the world after a picture is taken. If this is off, it will only be saved on your device.
FlipPreview Bool This flips the preview window, but not for the photo being taken. This also reverses the direction for the preview window when clicking on it as well.
_renderTextureProxy RenderTextureProxyProvider The texture to render to.
_framingReticle RectTransform The rectangle to frame with.
_mirrorMessage RectTransform The text for the label for the mirroring button.
_smoothFirstPersonButton Button Enable/disable button for smooth first person.
_thirdPersonButton Button Enable/disable button for
_groupButton Button Enable/disable button for
_worldButton Button Enable/disable button for
_manualButton Button Enable/disable button for
_mirrorButton Button Enable/disable button for
_usersButton Button Enable/disable button for
_angleIncreaseButton Button adjust button for
_angleDecreaseButton Button adjust button for
_heightIncreaseButton Button adjust button for
_heightDecreaseButton Button adjust button for
_distanceIncreaseButton Button adjust button for
_distanceDecreaseButton Button adjust button for
_resetButton Button resets the selected options to the default value.
_fovSlider Slider`1<Float> Slider for the Field of view amount.
_avoidOcclusion Checkbox When the camera is behind a wall or anything that is collidable, it will zoom the view in front of it to focus on the subject. This will not work in manual mode.
_keepInWorldSpace Checkbox This keeps the camera in world space.
_movementWobble Checkbox This makes the camera have gradual movement in different positions around the subject. This only works with Third Person or Group modes.
_aimInFrontOfHead Checkbox This aims the camera view more towards the user's head, specifically a few inches/centimeters in front of the head proxy's forward direction. This only works for the Third Person, Group, and World modes.
_forceEyesOnCamera Checkbox This makes the user's avatar's eyes lock on to the camera position.
_hideCamera Checkbox This hides the camera visual, but will still track the subject or stay in place as before with manual mode or with camera anchors.
_hideBadge Checkbox This hides the user's badges (including the nameplate) from the camera preview and any pictures taken.
_hideLasers Checkbox This hides the user's lasers from the camera preview and any pictures taken.
_showFrustum Checkbox This shows where the camera is aimed and focused at in 3D space.
_timer Checkbox Sets up the camera to have a timer when the photo button is pressed. The timer can be set to have a preset amount of time or a custom time, found on the back of the camera itself.
_forceLive Checkbox Shows the live badge to let other user's know that you are live and streaming to somewhere external from Resonite.
_audioFromCameraViewpoint Checkbox This moves your audio listeners (your audio output or ears) to where the camera is, overriding thier position to take in audio from. This can be checked for using the local output category in ProtoFlux.
_userControl InteractiveCameraUserControl see Interactive Camera User Control.
_settingsDialog Interactive Camera Control Settings see Interactive Camera Control Settings.
_positioningDialog InteractiveCameraControlPositioning see Interactive Camera Control Positioning.
_anchorsDialog InteractiveCameraControlAnchors see Interactive Camera Control Anchors.
_OBS_Dialog InteractiveCameraOBS see Interactive Camera OBS.
_twitchDialog TwitchChatDialog see Twitch Chat Dialog.
_settingsButton Button opens the settings for the camera.
_positioningButton Button Allows for changing the positioning
_anchorsButton Button Allows for changing the anchor points.
_OBS_Button Button Allows for showing and changing the OBS settings.
_twitchButton Button Allows for showing and changing the Twitch settings.
_previewMaterial UI_UnlitMaterial Shows the camera preview.

Usage

See Camera.

Examples

See Camera.

See Also