The abstract Camera node class. More...

#include "murl_graph_camera.h"

Inheritance diagram for Murl::Graph::Camera:

Additional Inherited Members

- Public Types inherited from Murl::IFactoryObject< INode >
using ClassInfoArray = Array< const ClassInfo * >
 Definition of an array of ClassInfo objects.
 
- Public Member Functions inherited from Murl::IFactoryObject< INode >
 ~IFactoryObject () override
 The destructor.
 
virtual const ClassInfo * GetObjectClassInfo () const=0
 Get the object instance's class info, if present. More...
 
virtual void ResetObjectProperties ()=0
 Reset the object instance's properties to their default values.
 
- Static Public Member Functions inherited from Murl::IFactoryObject< INode >
static const PropertyInfoGetPropertyInfo ()
 Get the class' property info struct. More...
 
static const AttributeInfoGetAttributeInfo ()
 Get the class' attribute info struct. More...
 
static void ResetProperties (IFactoryObject< INode > *object)
 Reset an object instance's properties to their default values. More...
 

Detailed Description

The abstract Camera node class.

XML Elements

XML Graph Node Attributes:

viewId="" [String]

The ID of the view to attach to. See Murl::Graph::ICamera::GetViewNodeTarget().

projectionType="PERSPECTIVE" [IEnums::ProjectionType]

The projection type. See Murl::Graph::ICamera::SetProjectionType().

depthOrder="0" [SInt32]

The camera's depth order within its view. See Murl::Graph::ICamera::SetDepthOrder().

depthSortMode="WORLD_Z" [IEnums::DepthSortMode]

The sorting mode for transparent rendering geometry. See Murl::Graph::ICamera::SetDepthSortMode().

screenOrientation="IEnums::SCREEN_ORIENTATION_DEFAULT" [IEnums::ScreenOrientation]

The camera's optional fixed screen orientation. See Murl::Graph::ICamera::SetScreenOrientation().

frontFacingVertexOrder="IEnums::VERTEX_ORDER_COUNTER_CLOCKWISE" [IEnums::VertexOrder]

The winding order of front-facing primitives. See Murl::Graph::ICamera::SetFrontFacingVertexOrder().

autoDeactivation="false" [Bool]

If true, the camera gets deactivated when no drawables are rendered. See Murl::Graph::ICamera::SetAutoDeactivationEnabled().

clearColorBuffer="true" [Bool]

If true, the color buffer gets cleared. See Murl::Graph::ICamera::SetColorBufferClearingEnabled().

clearDepthBuffer="true" [Bool]

If true, the depth buffer gets cleared. See Murl::Graph::ICamera::SetDepthBufferClearingEnabled().

clearStencilBuffer="false" [Bool]

If true, the stencil buffer gets cleared. See Murl::Graph::ICamera::SetStencilBufferClearingEnabled().

colorClearValue="0,0,0,1" [Color]

The color buffer clear value. See Murl::Graph::ICamera::SetColorBufferClearValue().

depthClearValue="1.0" [Real]

The depth buffer clear value. See Murl::Graph::ICamera::SetDepthBufferClearValue().

stencilClearValue="0" [UInt32]

The stencil buffer clear value. See Murl::Graph::ICamera::SetStencilBufferClearValue().

leftBorderCoord="0" [SInt32]

The offset of the area's left border, with regard to its anchor. See Murl::Graph::ICamera::SetBorderCoordsX().

rightBorderCoord="0" [SInt32]

The offset of the area's right border, with regard to its anchor. See Murl::Graph::ICamera::SetBorderCoordsX().

topBorderCoord="0" [SInt32]

The offset of the area's top border, with regard to its anchor. See Murl::Graph::ICamera::SetBorderCoordsY().

bottomBorderCoord="0" [SInt32]

The offset of the area's bottom border, with regard to its anchor. See Murl::Graph::ICamera::SetBorderCoordsY().

leftBorderAnchor="LEFT" [IEnums::AlignmentX]

The anchor for the area's left border. See Murl::Graph::ICamera::SetBorderAnchorsX().

rightBorderAnchor="RIGHT" [IEnums::AlignmentX]

The anchor for the area's right border. See Murl::Graph::ICamera::SetBorderAnchorsX().

topBorderAnchor="TOP" [IEnums::AlignmentY]

The anchor for the area's top border. See Murl::Graph::ICamera::SetBorderAnchorsY().

bottomBorderAnchor="BOTTOM" [IEnums::AlignmentY]

The anchor for the area's bottom border. See Murl::Graph::ICamera::SetBorderAnchorsY().

enableBorderMask="false" [Bool]

Enable/disable border masking. See Murl::Graph::ICamera::SetBorderMaskEnabled().

enableAspectClipping="false" [Bool]

Enable/disable aspect clipping. See Murl::Graph::ICamera::SetAspectClippingEnabled().

aspectRatio="1.0" [Real]

The aspect ratio of the virtual coordinate system. See Murl::Graph::ICamera::SetAspectRatio().

fieldOfViewX="0.0" [Real]

The horizontal field of view. See Murl::Graph::ICamera::SetFieldOfViewX().

fieldOfViewY="0.0" [Real]

The vertical field of view. See Murl::Graph::ICamera::SetFieldOfViewY().

unitSizeX="0.0" [Real]

The horizontal unit size. See Murl::Graph::ICamera::SetUnitSizeX().

unitSizeY="0.0" [Real]

The vertical unit size. See Murl::Graph::ICamera::SetUnitSizeY().

centerX="0.0" [Real]

The horizontal view volume center. See Murl::Graph::ICamera::SetCenterX().

centerY="0.0" [Real]

The vertical view volume center. See Murl::Graph::ICamera::SetCenterY().

shearX="0.0" [Real]

The horizontal view volume shearing. See Murl::Graph::ICamera::SetShearX().

shearY="0.0" [Real]

The vertical view volume shearing. See Murl::Graph::ICamera::SetShearY().

posX="0.0" [Real]

The horizontal position within the view. See Murl::Graph::ICamera::SetPositionX().

posY="0.0" [Real]

The vertical position within the view. See Murl::Graph::ICamera::SetPositionY().

sizeX="1.0" [Real]

The relative horizontal size within the view See Murl::Graph::ICamera::SetSizeX().

sizeY="1.0" [Real]

The relative vertical size within the view. See Murl::Graph::ICamera::SetSizeY().

nearPlane="1.0" [Real]

The absolute distance of the near clipping plane. See Murl::Graph::ICamera::SetNearPlaneZ().

farPlane="1000.0" [Real]

The absolute distance of the far clipping plane. See Murl::Graph::ICamera::SetFarPlaneZ().

clipPlaneA="0.0" [Real]

The "a" coefficient of the optional user clipping plane. See Murl::Graph::ICamera::SetClipPlane().

clipPlaneB="0.0" [Real]

The "b" coefficient of the optional user clipping plane. See Murl::Graph::ICamera::SetClipPlane().

clipPlaneC="0.0" [Real]

The "c" coefficient of the optional user clipping plane. See Murl::Graph::ICamera::SetClipPlane().

clipPlaneD="0.0" [Real]

The "d" coefficient of the optional user clipping plane. See Murl::Graph::ICamera::SetClipPlane().

clipPlaneNormalX="0.0" [Real]

The X component of the optional user clipping plane's normal vector. See Murl::Graph::ICamera::SetClipPlane().

clipPlaneNormalY="0.0" [Real]

The Y component of the optional user clipping plane's normal vector. See Murl::Graph::ICamera::SetClipPlane().

clipPlaneNormalZ="0.0" [Real]

The Z component of the optional user clipping plane's normal vector. See Murl::Graph::ICamera::SetClipPlane().

clipPlanePosX="0.0" [Real]

The X component of a point on the optional user clipping plane. See Murl::Graph::ICamera::SetClipPlane().

clipPlanePosY="0.0" [Real]

The Y component of a point on the optional user clipping plane. See Murl::Graph::ICamera::SetClipPlane().

clipPlanePosZ="0.0" [Real]

The Z component of a point on the optional user clipping plane. See Murl::Graph::ICamera::SetClipPlane().

slot="0" [SInt32]

The slot index to which the camera gets temporarily assigned during traversal of its children, in the range from 0 to Murl::IEnums::NUM_CAMERA_SLOTS-1. See Murl::Graph::IStateSlot::SetSlot().

maskCoordScaleFactor="1.0" [Real]

scale factor for all 4 MaskCoord properties.\ See Murl::Graph::ICamera::SetCoordScaleFactor().

leftMaskCoord="0.0" [Real]

The offset of the mask's left border, with regard to its anchor. See Murl::Graph::ICamera::SetMaskCoordsX().

rightMaskCoord="0.0" [Real]

The offset of the mask's right border, with regard to its anchor. See Murl::Graph::ICamera::SetMaskCoordsX().

topMaskCoord="0.0" [Real]

The offset of the mask's top border, with regard to its anchor. See Murl::Graph::ICamera::SetMaskCoordsY().

bottomMaskCoord="0.0" [Real]

The offset of the mask's bottom border, with regard to its anchor. See Murl::Graph::ICamera::SetMaskCoordsY().

leftMaskAnchor="LEFT" [IEnums::AlignmentX]

The anchor for the mask's left border. See Murl::Graph::ICamera::SetMaskAnchorsX().

rightMaskAnchor="RIGHT" [IEnums::AlignmentX]

The anchor for the mask's right border. See Murl::Graph::ICamera::SetMaskAnchorsX().

topMaskAnchor="TOP" [IEnums::AlignmentY]

The anchor for the mask's top border. See Murl::Graph::ICamera::SetMaskAnchorsY().

bottomMaskAnchor="BOTTOM" [IEnums::AlignmentY]

The anchor for the mask's bottom border. See Murl::Graph::ICamera::SetMaskAnchorsY().


The documentation for this class was generated from the following file:
  • murl_graph_camera.h


Copyright © 2011-2024 Spraylight GmbH.