UE3:SceneCapture2DComponent (UDK): Difference between revisions

From Unreal Wiki, The Unreal Engine Documentation Site
No edit summary
 
m 1 revision: class descriptions for UDK January update (part 4)
 
Line 1: Line 1:
{{infobox class
{{UE3:SceneCapture2DComponent (UT3)}}
| package = Engine
| parent1 = SceneCaptureComponent
| parent2 = ActorComponent
| parent3 = Component
| parent4 = Object
}}
{{autogenerated}}
SceneCapture2DComponent
 
Allows a scene capture to a 2D texture render target
 
==Properties==
===Property group 'Capture'===
====FarPlane====
'''Type:''' [[float]]
 
'''[[Variables#Modifiers|Modifiers]]:''' const
 
far plane clip distance: <= 0 means no far plane
 
'''Default value:''' 500.0
 
====FieldOfView====
'''Type:''' [[float]]
 
'''[[Variables#Modifiers|Modifiers]]:''' const
 
horizontal field of view
 
'''Default value:''' 80.0
 
====NearPlane====
'''Type:''' [[float]]
 
'''[[Variables#Modifiers|Modifiers]]:''' const
 
near plane clip distance
 
'''Default value:''' 20.0
 
====TextureTarget====
'''Type:''' {{cl|TextureRenderTarget2D}}
 
'''[[Variables#Modifiers|Modifiers]]:''' const
 
render target resource to set as target for capture
 
===Internal variables===
====bUpdateMatrices====
'''Type:''' [[bool]]
 
set to false to disable automatic updates of the view/proj matrices
 
'''Default value:''' True
 
====ProjMatrix====
'''Type:''' {{tl|Matrix|Object|structs}}
 
'''[[Variables#Modifiers|Modifiers]]:''' const, transient
 
projection matrix used for rendering
 
====ViewMatrix====
'''Type:''' {{tl|Matrix|Object|structs}}
 
'''[[Variables#Modifiers|Modifiers]]:''' const, transient
 
view matrix used for rendering
 
==Native functions==
====SetCaptureParameters====
{{code|native noexport final function '''SetCaptureParameters''' (optional&nbsp;{{cl|TextureRenderTarget2D}}&nbsp;'''NewTextureTarget''', optional&nbsp;[[float]]&nbsp;'''NewFOV''', optional&nbsp;[[float]]&nbsp;'''NewNearPlane''', optional&nbsp;[[float]]&nbsp;'''NewFarPlane''')}}
 
<!-- enter function description -->
 
====SetView====
{{code|native final function '''SetView''' ({{tl|Vector|Object|structs}}&nbsp;'''NewLocation''', {{tl|Rotator|Object|structs}}&nbsp;'''NewRotation''')}}
 
changes the view location and rotation
 
'''Note:''' unless bUpdateMatrices is false, this will get overwritten as soon as the component or its owner moves

Latest revision as of 05:44, 17 January 2010

UDK Object >> Component >> ActorComponent >> SceneCaptureComponent >> SceneCapture2DComponent
Package:
Engine
This class in other games:
This is an auto-generated page and may need human attention.
Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete.

SceneCapture2DComponent

Allows a scene capture to a 2D texture render target

Copyright 1998-2007 Epic Games, Inc. All Rights Reserved.

Properties

Property group 'Capture'

FarPlane

Type: float

Modifiers: const

far plane clip distance: <= 0 means no far plane

Default value: 500.0

FieldOfView

Type: float

Modifiers: const

horizontal field of view

Default value: 80.0

NearPlane

Type: float

Modifiers: const

near plane clip distance

Default value: 20.0

TextureTarget

Type: TextureRenderTarget2D

Modifiers: const

render target resource to set as target for capture

Internal variables

bUpdateMatrices

Type: bool

set to false to disable automatic updates of the view/proj matrices

Default value: True

ProjMatrix

Type: Object.Matrix

Modifiers: const, transient

projection matrix used for rendering

ViewMatrix

Type: Object.Matrix

Modifiers: const, transient

view matrix used for rendering

Native functions

SetCaptureParameters

native noexport final function SetCaptureParameters (optional TextureRenderTarget2D NewTextureTarget, optional float NewFOV, optional float NewNearPlane, optional float NewFarPlane)

interface for changing TextureTarget, FOV, and clip planes

SetView

native final function SetView (Object.Vector NewLocation, Object.Rotator NewRotation)

changes the view location and rotation

Note: unless bUpdateMatrices is false, this will get overwritten as soon as the component or its owner moves

Retrieved from "https://wiki.beyondunreal.com/index.php?title=UE3:SceneCapture2DComponent_(UDK)&oldid=41393"