PopcornFX v2.12

Generic selectors
Exact matches only
Search in title
Search in content
  1. Home
  2. Docs
  3. PopcornFX v2.12
  4. Node Reference
  5. Builtin nodes
  6. Samplers
  7. Shape

Shape

Overview

 

PropertyTypeDescription
SampleDimensionalityenumHow the shape should be sampled.

  • Vertex: Only works when ShapeType is MESH, samples points at the location of the mesh vertices.
  • Surface: Samples points located on the shape surface.
  • Volume: Only works when ShapeType is not MESH. Samples points in the shape volume.
ShapeTypeenumType of shape being sampled.

  • SPHERE: Simple sphere shape.
  • ELLIPSOID: Sphere with a non-uniform scale. Can also be an hemisphere.
  • CYLINDER: Simple cylinder shape.
  • CAPSULE: Simple capsule shape (cylinder with hemispherical ends).
  • CONE: Simple cone shape.
  • MESH: 3D model asset used as the shape to sample.
TransformTranslateboolTranslate the shape according to the specified position property.
TransformRotateboolRotate the shape according to the specified orientation property.
Positionfloat3Local shape position.
Orientationfloat3Local shape rotation. Those values are euler angles (in degres).
SPHERE
RadiusfloatSphere radius.

InnerRadiusfloatSphere inner radius.

NormalizedInnerRadiusfloatNormalized inner radius (InnerRadius / Radius).
ELLIPSOID
RadiusfloatEllipsoid radius, same as the sphere radius.
InnerRadiusfloatEllipsoid inner radius, same as the sphere radius.
NormalizedInnerRadiusfloatEllipsoid normalized radius, same as the sphere normalized radius.
HemisphereboolCut the sphere in half and only keep the top part.

NonUniformScalefloat3Scale the sphere on each axis.

CYLINDER
RadiusfloatCylinder radius. A cylinder with a radius of 0 is a line.

InnerRadiusfloatCylinder inner radius.

NormalizedInnerRadiusfloatNormalized cylinder inner radius (InnerRadius / Radius).
HeightfloatCylinder height. A cylinder with a height of 0 is a disk.

CAPSULE
RadiusfloatCapsule radius. A capsule with a radius of 0 is a line.

InnerRadiusfloatCapsule inner radius.

NormalizedInnerRadiusfloatNormalized capsule inner radius (InnerRadius / Radius).
HeightfloatCapsule height. A capsule with a height of 0 is a sphere.

CONE
RadiusfloatCone radius. A cone with a radius of 0 is a line.

HeightfloatCone height. A cone with a height of 0 is a disk.

MESH
MeshScalefloat3Scales the mesh along each axis.

MeshSamplingModeenumHow the mesh should be sampled.

  • Fast: Samples the mesh without taking its triangles sizes into account. Larger triangles will have a smaller density of points sampled on them.
  • Uniform: Samples the mesh uniformly. This means that the sampled points will be uniformly distributed over the mesh surface, taking into account the  mesh triangles sizes.
  • Weighted: Will sample points on the mesh depending on a per-vertex value specified by the DensityChannel property.
SubMeshIndexintIf the mesh asset is composed of multiple submeshes, this property is used to specify which submesh should be sampled.
DefaultUvStreamintIndex of the per-vertex UV stream that should be sampled by default if the mesh has multiple texture coordinates per-vertex.
DefaultColorStreamintIndex of the color stream that should be sampled by default if the mesh has multiple colors per-vertex.
DensityColorStreamintUsed when the MeshSamplingMode is set to Weighted. This is the index of the color stream that should be used as the density value if the mesh has multiple colors per-vertex.
DensityChannelenumUsed when the MeshSamplingMode is set to Weighted. This is the color channel that should be used as the density value for the sampling algorithm.
Output pins
DataGeometrydataThe geometry data that can be plugged in the mesh/shape sampling nodes.
+ all sampler properties

 

Was this article helpful to you? Yes No

How can we help?