sgCore Unreal Engine plugin Documentation

Download UE4 Demo Project

Download UE5 Demo Project

Basic Shapes

   

Box:

    Arguments:
  SizeX - box length on the X axis
  SizeY - box length on the Y axis
  SizeZ - box length on the Z axis

   

Sphere:

    Arguments:
  Radius - sphere radius
  Segments - the number of segments

   

Cylinder:

    Arguments:
  Radius - cylinder radius
  Height - cylinder height
  Segments - the number of cylinder segments

   

Cone:

    Arguments:
  Radius1 - radius of the first cone base
  Radius2 - radius of the second cone base
  Height - cone height
  Segments - the number of cone segments

   

Torus:

    Arguments:
  Radius - radius of the first torus base
  Thickness - torus thickness
  Segments - the number of torus segments

   

Line:

    Arguments:
  Begin Point - first line point
  End Point - second line point

   

Arc from 3 points:

    Arguments:
  Begin Point - begin arc point
  End Point - end arc point
  Arc Point - point on the arc
  Invert Arc - flag for arc invertion

   

Arc from Begin-End-Normal-Radius:

    Arguments:
  Begin Point - begin arc point
  End Point - end arc point
  Normal Vector - arc plane normal
  Radius - radius of the arc
  Invert Arc - flag for arc invertion

   

Arc from Center-Begin-End:

    Arguments:
  Center Point - center of the arc circle
  Begin Point - begin arc point
  End Point - end arc point
  Invert Arc - flag for arc invertion

   

Cirlce from 3 points:

    Arguments:
  Point1 - first circle point
  Point2 - second circle point
  Point3 - third circle point

   

Cirlce from Center-Radius-Normal:

    Arguments:
  Center Point - center of the circle
  Radius - radius of the cirlce
  Normal Vector - circle plane normal

   

Spline:

    Arguments:
  Spline Knots - array of knot points
  Close Spline - flag for spline closing

   

Contour:

    Arguments:
  Contour 2D Objects - array of contour 2D objects - can be Line or Arc object

Common Functions

   

Destroy Object:

    Arguments:
  Sg Object - Object

   

Set Object Material:

    Arguments:
  Sg Object - Object
  New Mat - Material

   

Set Object Transform:

    Arguments:
  Sg Object - Object
  Trans - Object Transform

Boolean Operations

   

Boolean Subtract:

    Arguments:
  Sg ObjectA - Object A
  Sg ObjectB - Object B

   

Boolean Intersection:

    Arguments:
  Sg ObjectA - Object A
  Sg ObjectB - Object B

   

Boolean Union:

    Arguments:
  Sg ObjectA - Object A
  Sg ObjectB - Object B

Kinematic Operations

   

Extrusion:

    Arguments:
  Profile 2DObject - flat 2D object, can be Circle, Arc, flat Spline or flat Contour
  Holes 2D Objects - holes array - array of flat 2D objects (can be Circle, Arc, flat Spline or flat Contour), array can be empty
  Direction Vector - Extrusion vector
  Is Solid - flag for closing to solid object

   

Revolve:

    Arguments:
  Profile 2DObject - rotated contour. Must be flat and not self-intersecting, can be Circle, Arc, flat Spline or flat Contour
  Axe Point 1 - first point on the rotation axis. Must lie on the rotated contour plane.
  Axe Point 2 - second point on the rotation axis. Must lie on the rotated contour plane. If the rotated contour is linear the rotation axis line must not coincide with the contour line
  Angle - the axis rotation angle (in degrees). Must not be equal to zero. The clockwise angle direction from axePnt1 to axePnt2 is positive.
  Is Solid - flag for closing to solid object
  Segments - the number of segments

   

Pipe:

    Arguments:
  Profile 2DObject - rotated contour. Must be flat and not self-intersecting, can be Circle, Arc, flat Spline or flat Contour
  Holes 2D Objects - holes array - array of flat 2D objects (can be Circle, Arc, flat Spline or flat Contour), array can be empty
  Guide Contour - object along which the outer contour and holes are extruded
  Point in Plane - a point in the outer contour plane which is moving along the pipe profile
  Angle Around Point - angle to turn the outer contour to and the holes around the point moving along the profile
  Is Solid - flag for closing to solid object

   

Spiral:

    Arguments:
  Profile 2DObject - outer contour. Must be flat and not self-intersecting, can be Circle, Arc, flat Spline or flat Contour
  Holes 2D Objects - holes array - array of flat 2D objects (can be Circle, Arc, flat Spline or flat Contour), array can be empty
  Axe Point 1 - first point on the spiral axis. Must lie on the outer contour plane.
  Axe Point 2 - second point on the spiral axis. Must lie on the outer contour plane. If the outer contour is linear the rotation axis line must not coincide with the contour line
  Screw Step - spiral step length
  Screw Height - spiral length
  Is Solid - flag for closing to solid object
  Segments - the number of segments

Surfaces

   

Face:

    Arguments:
  Out 2DObject - outer contour. Must be flat and not self-intersecting, can be Circle, Arc, flat Spline or flat Contour
  Holes 2D Objects - holes array - array of flat 2D objects (can be Circle, Arc, flat Spline or flat Contour), array can be empty

   

Linear Surface:

    Arguments:
  First Side - path curve for the first end point of the ruling line segment,
  Second Side - path curve for the second end point of the ruling line segment
  Twist Parameter - parameter of the point on the first path curve connecting with the start point on the second path curve; this parameter defines the spiral degree of the new object and takes the value from 0 to 1.
  Is Solid - flag for closing to solid object

   

Coons Surface from 3 side:

    Arguments:
  First Side - first boundary contour, can be Arc, Spline or Contour
  Second Side - second boundary contour, can be Arc, Spline or Contour. An end point must coincide with an end point of the previous argument
  Third Side - third boundary contour, can be Arc, Spline or Contour. An end point must coincide with the end point of the previous contour (Second Side) which doesn't coincide with the end point of the First Side.

   

Coons Surface from 4 side:

    Arguments:
  First Side - first boundary contour, can be Arc, Spline or Contour
  Second Side - second boundary contour, can be Arc, Spline or Contour. An end point must coincide with an end point of the previous argument
  Third Side - third boundary contour, can be Arc, Spline or Contour. An end point must coincide with the end point of the previous contour (Second Side) which doesn't coincide with the end point of the First Side.
  Fourth Side - fourth boundary contour, can be Arc, Spline or Contour. An end point must coincide with the end point of the previous contour (Third Side) which doesn't coincide with the end point of the First Side.