s3d.render

Functions and classes providing access and control of rendering processes.

Module Data

cameraLenses

A table of camera lens functions for use by the ray trace renderer. These map to the GUI controlled camera types by using the following table keys:

cameraLensFunctions

An internal table of the actual functions referenced by the cameraLenses table. It's entirely possible that some camera lens functions won't be in this table if they are user created functions, but all initially supplied camera lens functions will be in here.

Module Functions

Module Classes

CameraState

This class has the following construction methods:

CameraState()

description

CameraState(CameraState)

CameraState -> CameraState

description

Properties:

adjustedOrigin -> DoublePoint3d [read/write, shared reference]

adjustedDirection -> DoubleDir3d [read/write, shared reference]

adjustedUp -> DoubleDir3d [read/write, shared reference]

adjustedRight -> DoubleDir3d [read/write, shared reference]

viewOrigin -> DoublePoint3d [read/write, shared reference]

viewDirection -> DoubleDir3d [read/write, shared reference]

viewUp -> DoubleDir3d [read/write, shared reference]

viewRight -> DoubleDir3d [read/write, shared reference]

viewCenter -> Point [read/write, shared reference]

pixelAspect -> FloatPoint2d [read/write, shared reference]

relativeFrame -> FloatExtents2d [read/write, shared reference]

viewAngle -> Number [read-only]

rayConeAngleTangent -> Number [read/write]

rayConeBaseDiameter -> Number [read/write]

camera -> Camera [read-only]

cameraToWorld -> Transformation [read-only]

image -> Buffer [read-only]

tostring ()

CollisionInfo

Constructors:

CollisionInfo(CollisionInfo)

CollisionInfo -> CollisionInfo

description

CollisionInfo(Number, Number, Number, DoubleVectorPair3d, Number, Boolean)

Number -> Number

Number -> Number

DoubleVectorPair3d -> DoubleVectorPair3d

Number -> Number

Boolean -> Boolean

description

EntityHandler [derived from s3d.obj.Object]

Every instance of this class has the following member methods:

AddCollisionGeometry(Entity)

Entity -> Entity

description

AddEffectShader(String)

String -> String

description

BeginSurface()

description

ChangeResolution(Number, Boolean)

Number -> Number

Boolean -> Boolean

description

DetectSurfaceCollision(CollisionInfo) -> Boolean, IntersectionInfo

CollisionInfo -> Collisioninfo

description

DetectSurfaceCollision(CollisionInfo, IntersectionInfo [modifiable reference])-> Boolean

CollisionInfo -> CollisionInfo

IntersectionInfo -> IntersectionInfo

description

EndSurface()

description

GetAntiMatter() -> Boolean

description

GetCamera() -> Camera

description

GetCamera(Number) -> Camera, Transformation

Number -> Number

description

GetContext() -> Context

description

GetCurrentEntity() -> Entity

description

GetCurrentTransformation() -> Transformation

description

GetCurrentWorldExtent() -> DoubleExtents3d

description

GetDatabase() -> Database

description

GetEmitsCaustics() -> Boolean

description

GetEntityStackDepth() -> Integer

description

GetEnvironment() -> Environment

description

GetExtractionContext(Boolean) -> Integer

Boolean -> Boolean

description

GetFlipFaces() -> Boolean

description

GetIndexedEntity(Integer) -> Entity

Integer -> Integer

description

GetIndexedTransformation(Integer) -> Transformation

Integer -> Integer

description

GetIndexedTransformation(Integer, Boolean) -> Transformation

Integer -> Integer

Boolean -> Boolean

description

GetIndexedWorldExtent(Integer) -> DoubleExtents3d

Integer -> Integer

description

GetLocalTime() -> Number

description

GetLogicalEntityStackDepth() -> Integer

description

GetNamespace() -> ObjectNamespace

description

GetReceivesCaustics() -> Boolean

description

GetRenderer() -> Renderer

description

GetRendererInstance() -> RendererInstance

description

GetResolution() -> Number, Boolean

description

GetShadowCasting() -> Boolean

description

GetTime() -> Number

description

GetWorldTime() -> Number

description

HaveEntity(Entity)

Entity -> Entity

description

HaveRayTraceable(RayTraceable, Boolean)

RayTraceable -> RayTraceable

Boolean -> Boolean

description

HaveTriangles(DoublePoint3dArray)

DoublePoint3dArray -> DoublePoint3dArray

description

HaveTriangles(DoublePoint3dArray, FloatDir3dArray)

DoublePoint3dArray -> DoublePoint3dArray

FloatDir3dArray -> FloatDir3dArray

description

HaveTriangles(DoublePoint3dArray, FloatDir3dArray, FloatPointUVArray)

DoublePoint3dArray -> DoublePoint3dArray

FloatDir3dArray -> FloatDir3dArray

FloatPointUVArray -> FloatPointUVArray

description

HaveTriangles(Object)

Object -> Object

description

HaveTriangles(Object, Object)

Object -> Object

HaveTriangles(Object, Object, Object)

Object -> Object

description

HaveTrianglesOneSided(DoublePoint3dArray)

DoublePoint3dArray -> DoublePoint3dArray

description

HaveTrianglesOneSided(DoublePoint3dArray, FloatDir3dArray)

DoublePoint3dArray -> DoublePoint3dArray

FloatDir3dArray -> FloatDir3dArray

description

HaveTrianglesOneSided(DoublePoint3dArray, FloatDir3dArray, FloatPointUVArray)

DoublePoint3dArray -> DoublePoint3dArray

FloatDir3dArray -> FloatDir3dArray

FloatPointUVArray -> FloatPointUVArray

description

HaveTrianglesOneSided(Object)

Object -> Object

description

HaveTrianglesOneSided(Object, Object)

Object -> Object

description

HaveTrianglesOneSided(Object, Object, Object)

Object -> Object

description

HaveUnitCone(Boolean, Boolean)

Boolean -> Boolean

description

HaveUnitCone(Boolean, Boolean)

Boolean -> Boolean

description

HaveUnitCube(Boolean)

Boolean -> Boolean

description

HaveUnitCylinder(Boolean, Boolean)

Boolean -> Boolean

description

HaveUnitSphere(Boolean, Boolean)

Boolean -> Boolean

description

IsAllowingGeometry(Integer) -> Boolean

Integer -> Integer

description

IsExtractingGlobalProperties() -> Boolean

description

MayGiveRayTraceableRep(Boolean, Boolean, Boolean) -> Boolean

Boolean -> Boolean

description

PushRotation(DoubleQuaternion)

DoubleQuaternion -> DoubleQuaternion

description

PushRotation(DoubleQuaternion, Boolean)

DoubleQuaternion -> DoubleQuaternion

Boolean -> Boolean

description

PushScale(DoublePoint3d)

DoublePoint3d -> DoublePoint3d

description

PushScale(DoublePoint3d, Boolean)

DoublePoint3d -> DoublePoint3d

Boolean -> Boolean

description

PushSurfaceColor(RGBFloatPixel, Boolean)

RGBFloatPixel -> RGBFloatPixel

Boolean -> Boolean

description

String -> String

Number -> Number

description

PushTime(Number)

Number -> Number

description

PushTimeMapper(Object)

Object -> Object

description

PushTimeOffset(Number)

Number -> Number

description

PushTransformation(Transformation)

Transformation -> Transformation

description

PushTransformation(Transformation, Boolean)

Transformation -> Transformation

Boolean -> Boolean

description

PushTranslation(DoublePoint3d)

DoublePoint3d -> DoublePoint3d

description

PushTranslation(DoublePoint3d, Boolean)

DoublePoint3d -> DoublePoint3d

Boolean -> Boolean

description

PushVolumeShader(String)

String -> String

description

ReplaceEntity(DoubleExtents3d)

DoubleExtents3d -> DoubleExtents3d

description

ReplaceEntity(Entity)

Entity -> Entity

description

ReplaceEntity(Entity, Boolean)

Entity -> Entity

Boolean -> Boolean

description

ReplaceEntity(FloatExtents3d)

FloatExtents3d -> FloatExtents3d

description

ReplaceSurfaceShader(String)

String -> String

description

ReplaceTransformation(Transformation)

Transformation -> Transformation

description

ReplaceVolumeShader(String)

String -> String

description

SetAllowDefaultShader(Boolean) -> Boolean

Boolean -> Boolean

description

SetAllowParticles(Boolean) -> Boolean

Boolean -> Boolean

description

SetAntiMatter(Boolean)

Boolean -> Boolean

description

SetEmitsCaustics(Boolean)

Boolean -> Boolean

description

Number -> Number

Boolean -> Boolean

description

SetShadowCasting(Boolean)

Boolean -> Boolean

description

Renderer [derived from s3d.render.EntityHandler]

Activity constants:

kCollectingGeometry

kCollectingShadows

kFinished

kPreRolling

kRenderingEffectShaders

kRenderingFullFrame

kRenderingSubFrame

FieldOptions constants:

kEvenField

kNoFields

kOddField

StereoState constants:

kBothEyes

kLeftEye

kNoStereo

kRightEye

Methods:

GetCurrentActivity() -> Number, String

description

GetCurrentEntityViewRadius() -> Number

description

GetExcludeBackgroundFromAlpha() -> Boolean

description

GetFieldRenderingState() -> Number

description

GetLowMemoryFlag() -> Boolean

description

GetNumProcessorsUsed() -> Integer

description

GetStereoRenderingState() -> Number

description

GetSubFrameInfo() -> Boolean, Number, Integer, Integer

description

GetSupportsAlphaChannel() -> Boolean

description

IsCurrentEntityInView() -> Boolean

description

IsCurrentEntityInView(Boolean) -> Boolean

Booldean -> Boolean

description

SetExcludeBackgroundFromAlpha(Boolean)

Boolean -> Boolean

description

SupportsMultipleProcessors() -> Boolean

description

RendererInstance [derived from s3d.obj.StorageObject]

Type constants:

kFlat

kHiddenLine

kOutline

kPointCloud

kRayTracer

kRaydiosity

kScanLine

kSmooth

kToon1

kToon2

kToon3

kToon4

kToon5

kVector

kWireFrame

Methods:

GetCamera() -> Camera

description

GetCamera(Number) -> Camera, Transformation

Number -> Number

description

GetCameraPath() -> EntityPath

description

GetEndTime() -> Number

description

GetRenderer() -> Renderer

description

GetRendererType() -> Integer

description

GetRenderingLayers() -> Boolean, RenderingLayers

description

GetRenderingOptions() -> RenderingOptions

description

GetRenderingSettings() -> RenderingSettings

description

GetStartTime() -> Number

description

GetTimeRendering() -> Number

description

GetTimeStep() -> Number

description

GetViewTransformation(Number) -> DoubleMatrix4x4

Number -> Number

description

GetViewTransformation(Number, Boolean) -> DoubleMatrix4x4

Number -> Number

Boolean -> Boolean

description

IsRenderingFinished() -> Boolean

description

IsRenderingStarted() -> Boolean

description

SetRenderingLayers(RenderingLayers)

RenderingLayers -> RenderingLayers

description

SetRenderingOptions(RenderingOptions)

RenderingOptions -> RenderingOptions

description

SetRenderingSettings(RenderingSettings)

RenderingSettings -> RenderingSettings

description

RenderingLayers

Properties:

enabled -> Boolean [read/write]

composited -> Boolean [read/write]

postEffects -> Boolean [read/write]

atmospherics -> Boolean [read/write]

transmitted -> Boolean [read/write]

reflected -> Boolean [read/write]

ambient -> Boolean [read/write]

diffuse -> Boolean [read/write]

shadowColor -> Boolean [read/write]

specular -> Boolean [read/write]

background -> Boolean [read/write]

depth -> Boolean [read/write]

objectSelection -> Boolean [read/write]

shaderSelection -> Boolean [read/write]

objectMask -> Boolean [read/write]

shadowMask -> Boolean [read/write]

transparency -> Boolean [read/write]

RenderingOptions

Properties:

refractionEnabled -> Boolean [read/write]

shadowsEnabled -> Boolean [read/write]

transparentShadowsEnabled -> Boolean [read/write]

RenderingSettings

Properties:

fieldRendering -> Number [read/write]

oversampling -> Integer [read/write]

filtering -> Boolean [read/write]

particlePreRoll -> Boolean [read/write]