APEX NvParameterized Schemas: GroundEmitterActorParameters Struct Reference

NVIDIA APEX

GroundEmitterActorParameters Struct Reference

Describes the NxParameterized::Interface for 'GroundEmitterActorParameters' : This class is used for creating NxGroundEmitterActor instances. More...

#include <params.h>

List of all members.

Public Attributes

F32 densityRange.min
 'densityRange.min' : Minimum (scalar value)
F32 densityRange.max
 'densityRange.max' : Maximum (scalar value)
F32 radius
 'radius' : Radius
Vec3 upDirection
 'upDirection' : Up Direction
F32 raycastHeight
 'raycastHeight' : Raycast Height
F32 spawnHeight
 'spawnHeight' : Spawn Height
U32 maxRaycastsPerFrame
 'maxRaycastsPerFrame' : Maximum Raycasts per Frame
String raycastCollisionGroupMaskName
 'raycastCollisionGroupMaskName' : Raycast Collision Group Mask Name
Vec3 attachRelativePosition
 'attachRelativePosition' : Attach Relative Position
Mat34 globalPose
 'globalPose' : The actor's pose

Detailed Description

Describes the NxParameterized::Interface for 'GroundEmitterActorParameters' : This class is used for creating NxGroundEmitterActor instances.

GroundEmitterActorParameters contains 10 fully qualified names
---------------------------------------------
  1 : F32     densityRange.min               
  2 : F32     densityRange.max               
  3 : F32     radius                         
  4 : Vec3    upDirection                    
  5 : F32     raycastHeight                  
  6 : F32     spawnHeight                    
  7 : U32     maxRaycastsPerFrame            
  8 : String  raycastCollisionGroupMaskName  
  9 : Vec3    attachRelativePosition         
 10 : Mat34   globalPose                     

Member Data Documentation

'attachRelativePosition' : Attach Relative Position

The ground emitter will offset this value from the attach actor position.

'densityRange.max' : Maximum (scalar value)

'densityRange.min' : Minimum (scalar value)

'globalPose' : The actor's pose

An identity rotation matrix will result in a +Y up ground emitter, provide a rotation if another orientation is desired.

'maxRaycastsPerFrame' : Maximum Raycasts per Frame

The maximum raycasts per frame.

'radius' : Radius

The ground emitter actor will create objects within a circle of size 'radius'.

'raycastCollisionGroupMaskName' : Raycast Collision Group Mask Name

This name resolves to a 32-bit bitmask of collision groups for raycasts around the player. It is resolved by a call to the named resource provider using the 'NSCollisionGroupMask' and 'NSCollisionGroup128' namespaces. If none is provided, the raycast will hit everything in the scene. This avoids storing fragile enums in asset files.

'raycastHeight' : Raycast Height

The height from which the ground emitter will cast rays at terrain/objects opposite of the 'upDirection'.

'spawnHeight' : Spawn Height

The height above the ground to emit particles. If greater than 0, the ground emitter will refresh a disc above the player's position rather than refreshing a circle around the player's position.

'upDirection' : Up Direction

The ground emitter asset needs to know what direction is 'up'.


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

Generated on Fri Dec 15 2017 13:59:11

Copyright © 2012-2017 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved.