unreal.GeometryScript_Box
¶
- class unreal.GeometryScript_Box(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
BlueprintFunctionLibrary
Geometry Script Library Box Functions
C++ Source:
Plugin: GeometryScripting
Module: GeometryScriptingCore
File: ShapeFunctions.h
- classmethod find_box_box_intersection(box1, box2) -> (Box, is_intersecting=bool)¶
Find the Box formed by the intersection of Box1 and Box2
- classmethod find_closest_point_on_box(box, point) -> (Vector, is_inside=bool)¶
Find the point on the faces of the Box that is closest to the input Point. If the Point is inside the Box, it is returned, ie points Inside do not project to the Box Faces
- classmethod get_box_box_distance(box1, box2) double ¶
Calculate the minimum distance between Box1 and Box2
- classmethod get_box_center_size(box) -> (center=Vector, dimensions=Vector)¶
Get the Center point and X/Y/Z Dimensions of a Box (full dimensions, not Extents)
- Parameters:
box (Box) –
- Returns:
center (Vector):
dimensions (Vector):
- Return type:
tuple
- classmethod get_box_corner(box, corner_index) Vector ¶
Get the position of a corner of the Box. Corners are indexed from 0 to 7, using an ordering where 0 is the Min corner, 1/2/3 are +Z/+Y/+X from the Min corner, 7 is the Max corner, and 4/5/6 are -Z/-Y/-X from the Max corner.
- classmethod get_box_face_center(box, face_index) -> (Vector, face_normal=Vector)¶
Get the position of the center of a face of the Box. Faces are indexed from 0 to 5, using an ordering where 0/1 are the MinZ/MaxZ faces, 2/3 are MinY/MaxY, and 4/5 are MinX/MaxX
- classmethod get_box_point_distance(box, point) double ¶
Calculate the minimum distance between the Box and the Point
- classmethod get_box_volume_area(box) -> (volume=double, surface_area=double)¶
Get the Volume and Surface Area of a Box
- Parameters:
box (Box) –
- Returns:
volume (double):
surface_area (double):
- Return type:
tuple
- classmethod get_expanded_box(box, expand_by) Box ¶
Get the input Box expanded by adding the ExpandBy parameter to both the Min and Max. Dimensions will be clamped to the center point if any of ExpandBy are larger than half the box size
- classmethod get_transformed_box(box, transform) Box ¶
Apply the input Transform to the corners of the input Box, and return the new Box containing those points
- classmethod make_box_from_center_extents(center, extents) Box ¶
Create a Box from a Center point and X/Y/Z Extents (Extents are half-dimensions)
- classmethod make_box_from_center_size(center, dimensions) Box ¶
Create a Box from a Center point and X/Y/Z Dimensions (not Extents, which are half-dimensions)
- classmethod test_box_sphere_intersection(box, sphere_center, sphere_radius) bool ¶
Check if the Box intersects a Sphere defined by the SphereCenter and SphereRadius