wiki.sine.space | sinespace

Difference between revisions of "Scripting/SCamera"

From wiki.sine.space
Jump to: navigation, search
(Replaced content with "This page has moved to: https://docs.sine.space/v/scripting/client-scripting/components/scamera")
 
Line 1: Line 1:
=Members=
+
This page has moved to: https://docs.sine.space/v/scripting/client-scripting/components/scamera
 
+
{{ScriptFunction|void|TakePhoto|()|Triggers the Photo window in the UI, with the output of this camera. Perfect for photo booths.|5=local Object = Space.Scene.Find("Camera")<br>
+
Object.Camera.TakePhoto()
+
}}
+
 
+
{{ScriptFunction|SResource|TakeSnapshot|()|Captures a texture from the camera, and saves it in a SResource|5=local Object = Space.Scene.Find("Camera")<br>
+
Object.Camera.TakeSnapshot().Name;
+
}}
+
 
+
 
+
 
+
=Properties=
+
 
+
{{ScriptFunction|bool|Enabled|{ get; set; }|Is this camera enabled?|5=
+
local Object = Space.Scene.Find("Camera")<br>
+
Space.Log(Object.Camera.Enabled);<br>
+
''--print true.''|6=<pre>--clicking this object will Enable/Disable it's Camera component
+
thisGameObject = Space.Host.ExecutingObject
+
component = thisGameObject.Camera
+
 
+
 
+
OnClick = function()
+
component.Enabled =  not component.Enabled
+
end
+
 
+
 
+
thisGameObject.AddClickable()
+
thisGameObject.Clickable.OnClick(OnClick)</pre>
+
}}
+
 
+
{{ScriptFunction|float|FarClip|{ get; set; }|How far is an object from the camera plane before it is not rendered?|5=
+
local Object = Space.Scene.Find("Camera")<br>
+
Space.Log(Object.Camera.FarClip)
+
}}
+
 
+
{{ScriptFunction|float|FieldOfView|{ get; set; }|The field of view of the camera, in typical scenarios, Sinespace uses a value of 52; however Unity will default to 60.|5= local Object = Space.Scene.Find("Camera")<br>
+
Space.Log(Object.Camera.FieldOfView)
+
}}
+
 
+
{{ScriptFunction|bool|HDR|{ get; set; }|Can this camera write HDR values? (i.e. values brighter than 1.0)|5=  local Object = Space.Scene.Find("Camera")<br>
+
Space.Log(Object.Camera.HDR)<br>
+
''--print true.''
+
}}
+
 
+
{{ScriptFunction|float|NearClip|{ get; set; }|How close can an object be to the camera plane before it is not rendered?|5= local Object = Space.Scene.Find("Camera")<br>
+
Space.Log(Object.Camera.NearClip)}}
+
 
+
{{ScriptFunction|bool|Orthographic|{ get; set; }|Does this camera render without perspective?|5=
+
local Object = Space.Scene.Find("Camera")<br>
+
Space.Log(Object.Camera.Orthographic)
+
}}
+
 
+
{{ScriptFunction|float|OrthographicSize|{ get; set; }|The width of the camera when in Orthographic mode. Height will be adjusted based on aspect ratio of the Render Texture|5= local Object = Space.Scene.Find("Camera")<br>
+
Space.Log(Object.Camera.OrthographicSize)
+
}}
+
 
+
{{ScriptFunction|int|PixelHeight|{ get;  }|The height of this Camera's texture in pixels|5=
+
local Object = Space.Scene.Find("Camera")<br>
+
Space.Log(Object.Camera.PixelHeight)
+
}}
+
 
+
{{ScriptFunction|int|PixelWidth|{ get; }|The width of this Camera's texture, in pixels|5= local Object = Space.Scene.Find("Camera")<br>
+
Space.Log(Object.Camera.PixelWidth)
+
}}
+
 
+
{{ScriptFunction|bool|UseOcclusionCulling|{ get; set;}|Is Occlusion Culling enabled on this camera?|5=
+
local Object = Space.Scene.Find("Camera")<br>
+
Space.Log(Object.Camera.UseOcclusionCulling)<br>
+
''--print true.''
+
}}
+
 
+
{{ScriptFunction|SVector|Velocity|{ get; }|World space speed of this camera, typically used for motion blur.|5=
+
local Object = Space.Scene.Find("Camera")<br>
+
local VectorData = Object.Camera.Velocity;<br>
+
Space.Log(VectorData)
+
}}
+
 
+
 
+
 
+
 
+
 
+
{{Scripting Navbox}}
+

Latest revision as of 05:27, 19 September 2022

This page has moved to: https://docs.sine.space/v/scripting/client-scripting/components/scamera