UM.Scene.Camera.Camera Class Reference

A SceneNode subclass that provides a camera object. More...

Inheritance diagram for UM.Scene.Camera.Camera:

Public Member Functions
def	__init__
def	__deepcopy__
def	getZoomFactor (self)
def	setZoomFactor
def	setMeshData
def	getAutoAdjustViewPort (self)
def	setAutoAdjustViewPort
def	getProjectionMatrix (self)
	Get the projection matrix of this camera. More...
def	getViewportWidth (self)
def	setViewportWidth
def	setViewportHeight
def	setViewportSize
def	getViewProjectionMatrix (self)
def	getViewportHeight (self)
def	setWindowSize
def	getWindowSize (self)
def	render (self, renderer)
def	setProjectionMatrix
	Set the projection matrix of this camera. More...
def	getInverseWorldTransformation (self)
def	getCameraLightPosition (self)
def	isPerspective (self)
def	setPerspective
def	getRay
	Get a ray from the camera into the world. More...
def	project
	Project a 3D position onto the 2D view plane. More...
Public Member Functions inherited from UM.Scene.SceneNode.SceneNode
def	__init__
	Construct a scene node. More...
def	__deepcopy__
def	setCenterPosition
	Set the center position of this node. More...
def	getParent (self)
	Get the parent of this node. More...
def	getMirror (self)
def	setMirror (self, vector)
def	getBoundingBoxMesh (self)
	Get the MeshData of the bounding box. More...
def	calculateBoundingBoxMesh (self)
	(re)Calculate the bounding box mesh. More...
def	collidesWithBbox
	Return if the provided bbox collides with the bbox of this SceneNode.
def	addDecorator
	Add a SceneNodeDecorator to this SceneNode. More...
def	getDecorators (self)
	Get all SceneNodeDecorators that decorate this SceneNode. More...
def	getDecorator
	Get SceneNodeDecorators by type. More...
def	removeDecorators (self)
	Remove all decorators.
def	removeDecorator
	Remove decorator by type. More...
def	callDecoration
	Call a decoration of this SceneNode. More...
def	hasDecoration
	Does this SceneNode have a certain Decoration (as defined by a Decorator) More...
def	getName (self)
def	setName
def	getDepth (self)
	How many nodes is this node removed from the root? More...
def	setParent
	Set the parent of this object. More...
def	isVisible (self)
	Get the visibility of this node. More...
def	setVisible
	Set the visibility of this SceneNode. More...
def	getMeshData (self)
	Get the (original) mesh data from the scene node/object. More...
def	getMeshDataTransformed (self)
	Get the transformed mesh data from the scene node/object, based on the transformation of scene nodes wrt root. More...
def	getMeshDataTransformedVertices (self)
	Get the transformed vertices from this scene node/object, based on the transformation of scene nodes wrt root. More...
def	getMeshDataTransformedNormals (self)
	Get the transformed normals from this scene node/object, based on the transformation of scene nodes wrt root. More...
def	setMeshData
	Set the mesh of this node/object. More...
def	addChild
	Add a child to this node and set it's parent as this node. More...
def	removeChild
	remove a single child More...
def	removeAllChildren (self)
	Removes all children and its children's children. More...
def	getChildren (self)
	Get the list of direct children. More...
def	hasChildren (self)
def	getAllChildren (self)
	Get list of all children (including it's children children children etc.) More...
def	getWorldTransformation (self)
	Computes and returns the transformation from world to local space. More...
def	getLocalTransformation (self)
	Returns the local transformation with respect to its parent. More...
def	setTransformation
def	getOrientation (self)
	Get the local orientation value. More...
def	getWorldOrientation (self)
def	rotate
	Rotate the scene object (and thus its children) by given amount. More...
def	setOrientation
	Set the local orientation of this scene node. More...
def	getScale (self)
	Get the local scaling value. More...
def	getWorldScale (self)
def	scale
	Scale the scene object (and thus its children) by given amount. More...
def	setScale
	Set the local scale value. More...
def	getPosition (self)
	Get the local position. More...
def	getWorldPosition (self)
	Get the position of this scene node relative to the world. More...
def	translate
	Translate the scene object (and thus its children) by given amount. More...
def	setPosition
	Set the local position value. More...
def	lookAt
	Rotate this scene node in such a way that it is looking at target. More...
def	render (self, renderer)
	Can be overridden by child nodes if they need to perform special rendering. More...
def	isEnabled (self)
	Get whether this SceneNode is enabled, that is, it can be modified in any way. More...
def	setEnabled
	Set whether this SceneNode is enabled. More...
def	isSelectable (self)
	Get whether this SceneNode can be selected. More...
def	setSelectable
	Set whether this SceneNode can be selected. More...
def	getBoundingBox (self)
	Get the bounding box of this node and its children. More...
def	setCalculateBoundingBox
	Set whether or not to calculate the bounding box for this node. More...
def	getShear (self)
def	getSetting
def	setSetting
def	invertNormals (self)
def	__str__ (self)
	String output for debugging. More...

Static Public Member Functions
def	getDefaultZoomFactor ()

Static Public Attributes
tuple	perspectiveChanged = Signal()
Static Public Attributes inherited from UM.Scene.SceneNode.SceneNode
tuple	decoratorsChanged = Signal()
	Signal for when a SceneNodeDecorator is added / removed. More...
tuple	parentChanged = Signal()
	Emitted whenever the parent changes. More...
tuple	meshDataChanged = Signal()
	Emitted whenever the attached mesh data object changes. More...
tuple	childrenChanged = Signal()
	Emitted whenever the list of children of this object or any child object changes. More...
tuple	transformationChanged = Signal()
	Signal. More...
tuple	boundingBoxChanged = Signal()

Detailed Description

A SceneNode subclass that provides a camera object.

The camera provides a projection matrix and its transformation matrix can be used as view matrix.

Member Function Documentation

def UM.Scene.Camera.Camera.getProjectionMatrix	(		self,
			Matrix
	)

Get the projection matrix of this camera.

def UM.Scene.Camera.Camera.getRay	(		self,
			x
	)

Get a ray from the camera into the world.

This will create a ray from the camera's origin, passing through (x, y) on the near plane and continuing based on the projection matrix.

Parameters

x	The X coordinate on the near plane this ray should pass through.
y	The Y coordinate on the near plane this ray should pass through.

Returns

A Ray object representing a ray from the camera origin through X, Y.

Note

The near-plane coordinates should be in normalized form, that is within (-1, 1).

def UM.Scene.Camera.Camera.project	(		self,
			position
	)

Project a 3D position onto the 2D view plane.

def UM.Scene.Camera.Camera.setProjectionMatrix	(		self,
			matrix
	)

Set the projection matrix of this camera.

Parameters

matrix

The projection matrix to use for this camera.

---

The documentation for this class was generated from the following file:

• UM/Scene/Camera.py