DrawObjectsRenderPass Class Reference

Use the Draw Objects Render Pass to render only nodes in a Scene node provided by an object source you set in this render pass. More...

Inheritance diagram for DrawObjectsRenderPass:

Static Public Member Functions
static< T extends KanziObject > ObjectRef< T >	create (Domain domain, String name)
	Create a Draw Objects Render Pass.

Static Public Attributes
static final Metaclass	metaclass
	The Metaclass for the class.
Static Public Attributes inherited from RenderPass
static final Metaclass	metaclass
	The Metaclass for the class.
Static Public Attributes inherited from GPUResource
static final Metaclass	metaclass
	The Metaclass for the class.
Static Public Attributes inherited from Resource
static final Metaclass	metaclass
	The Metaclass for the class.
Static Public Attributes inherited from KanziObject
static final Metaclass	metaclass = new AbstractMetaclass("Kanzi.Object")
	The Metaclass for the class.

Additional Inherited Members
Public Member Functions inherited from Resource
String	getName ()
	Gets the resource name.
String	getUrl ()
	Gets the resource URL.
void	setKeepAlive (boolean keepAlive)
	Sets the keep alive flag.
Public Member Functions inherited from KanziObject
boolean	equals (Object object)
Domain	getDomain ()
	Returns the domain the object belongs to.
Metaclass	getDynamicMetaclass ()
	Returns the metaclass of the dynamic type of the object.
long	getNative ()
	Gets a pointer to the backing C++ instance.
TDataType	getOptionalProperty (PropertyType< TDataType > propertyType)
	Returns the current value of a property type, but does not use the default value if there are no inputs to the property value.
TDataType	getProperty (PropertyType< TDataType > propertyType)
	Returns the current value of a property type.
int	hashCode ()
boolean	hasValue (PropertyType< TDataType > propertyType)
	Evaluates whether there are any inputs into the property value.
boolean	isStale ()
	Test if the object is stale i.e.
void	removeLocalValue (PropertyType< TDataType > propertyType)
	Removes the local value associated with the property.
void	setProperty (PropertyType< TDataType > propertyType, TDataType value)
	Sets the local value of a property type.
ObjectRef< TType >	tryCreateObjectRef (Class< TType > clazz)
	Tries to create an owning ObjectRef instance to this KanziObject.
Public Attributes inherited from ResourceMetadata
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.Resource")
	Metaclass for Resource.
Public Attributes inherited from GPUResourceMetadata
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.GPUResource")
	Metaclass for GPUResource.
Public Attributes inherited from RenderPassMetadata
DynamicPropertyType< Boolean >	EnabledProperty
	Whether Kanzi executes this render pass and its child render pass tree.
DynamicPropertyType< Vector4 >	InputViewportAreaProperty
	Reports the viewport area relative to the composition space as passed from the parent render pass.
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.RenderPass")
	Metaclass for RenderPass.
DynamicPropertyType< Integer >	UpdateOffsetProperty
	Sets a frame offset to the rendering rate that you set with the Update Rate property.
DynamicPropertyType< Integer >	UpdateRateProperty
	Sets the rate at which to render the Render Pass.
Public Attributes inherited from DrawObjectsRenderPassMetadata
DynamicPropertyType< Matrix4x4 >	CameraMatrixProperty
	The camera matrix that the Draw Objects Render Pass calculates during rendering from the settings of the Camera and passes to the shader.
DynamicPropertyType< Vector3 >	CameraPositionProperty
	The camera position that the Draw Objects Render Pass calculates during rendering from the settings of the Camera and passes to the shader.
DynamicPropertyType< String >	CameraProperty
	Sets the Camera node that you want to use to render the nodes.
DynamicPropertyType< Boolean >	FrustumCullingEnabledProperty
	Enable to disable rendering objects that are not inside the view frustum.
AbstractMetaclass	metaclass = new AbstractMetaclass("Kanzi.DrawObjectsRenderPass")
	Metaclass for DrawObjectsRenderPass.
DynamicPropertyType< Vector2 >	NearFarPlaneProperty
	The distances to the camera near and far planes that the Draw Objects Render Pass calculates during rendering from the settings of the Camera and passes to the shader.
DynamicPropertyType< Resource >	ObjectSourceProperty
	Sets the object source which collects the nodes that you want to render with this render pass.
DynamicPropertyType< Matrix4x4 >	ProjectionMatrixProperty
	The projection matrix that the Draw Objects Render Pass calculates during rendering from the settings of the Camera and passes to the shader.
DynamicPropertyType< Vector4 >	ViewportProperty
	Viewport applied by the rendering of the Draw Objects Render Pass.
DynamicPropertyType< Vector4 >	ViewPositionProperty
	The homogeneous view position that the Draw Objects Render Pass calculates during rendering from the settings of the Camera and passes to the shader.

Detailed Description

Use the Draw Objects Render Pass to render only nodes in a Scene node provided by an object source you set in this render pass.

The Draw Objects Render Pass renders objects from the object source you set in the ObjectSourceProperty property with the Camera node that the Scene node uses. The Camera node that a Draw Objects Render Pass uses must be in the same Scene node as the objects that the Draw Objects Render Pass renders.

Member Function Documentation

create()

static< T extends KanziObject > ObjectRef< T > create ( Domain domain, String name )

static

Create a Draw Objects Render Pass.

Parameters

domain	The domain to use.
name	The name of the Draw Objects Render Pass.

Returns

The created Draw Objects Render Pass.

Reimplemented from RenderPass.

Reimplemented in DrawObjectsWithMaterialRenderPass.

Member Data Documentation

metaclass

final Metaclass metaclass

static

Initial value:

=
        com.rightware.kanzi.metadata.DrawObjectsRenderPassMetadata.metaclass

The Metaclass for the class.