a3d::FinitePlanePhysicsShape Class Reference
Finite rectangular collision plane centered at the local origin in the XY plane. More...
#include <a3d/physics/shape/primitive/FinitePlanePhysicsShape.h>
Inheritance diagram for a3d::FinitePlanePhysicsShape:
Public Member Functions | |
| FinitePlanePhysicsShape (float width, float height) | |
| Creates a finite collision plane with full width along X and full height along Y. More... | |
| float | width () const |
| Returns the configured full width along X. More... | |
| float | height () const |
| Returns the configured full height along Y. More... | |
| Type | type () const override |
| Returns PhysicsShape::Type::Primitive. More... | |
| void | type (Type type) override |
| Rejects attempts to change the fixed primitive shape type. More... | |
 Public Member Functions inherited from a3d::PhysicsShape | |
| PhysicsShape (Type type, const std::shared_ptr< Mesh > &mesh) | |
Creates a PhysicsShape of type derived from mesh. More... | |
| PhysicsShape (Type type, const std::shared_ptr< Node > &node) | |
Creates a PhysicsShape of type from mesh geometry in the node hierarchy. More... | |
| virtual Type | type () const |
| Returns the collision-geometry type. More... | |
| virtual void | type (Type type) |
| Validates the requested collision-geometry type. More... | |
| Source | source () const |
| Returns the weak Mesh or Node source, or std::monostate for a source-less primitive shape. More... | |
Additional Inherited Members | |
| Public Types inherited from a3d::PhysicsShape | |
| enum class | Type : uint8_t { Primitive , BoundingBox , ConvexHull , ConcavePolyhedron } |
| Collision-geometry representation requested for a PhysicsShape. More... | |
| using | Source = std::variant< std::monostate, std::weak_ptr< Mesh >, std::weak_ptr< Node > > |
| Weak source object used to derive collision geometry, or no source for primitive shapes. More... | |
| Static Public Member Functions inherited from a3d::PhysicsShape | |
| static std::shared_ptr< PhysicsShape > | BoundingBoxShape (const std::shared_ptr< Mesh > &mesh) |
Creates a bounding-box collision shape derived from mesh. More... | |
| static std::shared_ptr< PhysicsShape > | BoundingBoxShape (const std::shared_ptr< Node > &node) |
Creates a bounding-box collision shape from mesh geometry in the node hierarchy. More... | |
| static std::shared_ptr< PhysicsShape > | ConvexHullShape (const std::shared_ptr< Mesh > &mesh) |
Creates a convex-hull collision shape derived from mesh. More... | |
| static std::shared_ptr< PhysicsShape > | ConvexHullShape (const std::shared_ptr< Node > &node) |
Creates a convex-hull collision shape from mesh geometry in the node hierarchy. More... | |
| static std::shared_ptr< PhysicsShape > | ConcavePolyhedronShape (const std::shared_ptr< Mesh > &mesh) |
Creates a concave-polyhedron collision shape derived from mesh. More... | |
| static std::shared_ptr< PhysicsShape > | ConcavePolyhedronShape (const std::shared_ptr< Node > &node) |
Creates a concave-polyhedron collision shape from mesh geometry in the node hierarchy. More... | |
Detailed Description
Finite rectangular collision plane centered at the local origin in the XY plane.
Definition at line 17 of file FinitePlanePhysicsShape.h.
Constructor & Destructor Documentation
◆ FinitePlanePhysicsShape()
| a3d::FinitePlanePhysicsShape::FinitePlanePhysicsShape | ( | float | width, |
| float | height | ||
| ) |
Creates a finite collision plane with full width along X and full height along Y.
Member Function Documentation
◆ height()
| float a3d::FinitePlanePhysicsShape::height | ( | ) | const |
Returns the configured full height along Y.
◆ type() [1/2]
|
overridevirtual |
Returns PhysicsShape::Type::Primitive.
Reimplemented from a3d::PhysicsShape.
◆ type() [2/2]
|
overridevirtual |
Rejects attempts to change the fixed primitive shape type.
- Exceptions
-
std::logic_error always; FinitePlanePhysicsShape has a fixed type.
Reimplemented from a3d::PhysicsShape.
◆ width()
| float a3d::FinitePlanePhysicsShape::width | ( | ) | const |
Returns the configured full width along X.
The documentation for this class was generated from the following file:
- a3d/physics/shape/primitive/FinitePlanePhysicsShape.h
