Difference between revisions of "Shape"

m (1 revision: Importing from potato (again).)
(Undo revision 25919 by Popolon (talk))
 
(15 intermediate revisions by 12 users not shown)
Line 1: Line 1:
 +
[[Shape|Shapes]] are solid 2d geometrical objects which handle the mass and collision of a [[Body]] in [[love.physics]].
  
−
Shapes are objects used to control mass and collisions.
+
[[Shape|Shapes]] are attached to a [[Body]] via a [[Fixture]]. The [[Shape]] object is copied when this happens.  
  
−
Every shape is either a circle or a polygon, and is attached to a Body.
+
The [[Shape]]'s position is relative to the position of the [[Body]] it has been attached to.
−
 
 
−
 
 
−
Create a new shape with [[love.physics.newCircleShape]], [[love.physics.newPolygonShape]] or [[love.physics.newRectangleShape]].
 
  
 +
== Constructors ==
 +
{{#ask: [[Category:Functions]] [[Constructs::Shape]] [[Concept:Current]]
 +
| headers=hide
 +
| default=None.
 +
| format=template
 +
| template=ListingFields
 +
| introtemplate=ListingIntro
 +
| outrotemplate=ListingOutro
 +
| ?Description
 +
| ?PrettySince
 +
| ?PrettyRemoved
 +
}}
 
== Functions ==
 
== Functions ==
−
{{#ask: [[Category:Functions]] [[parent::Shape]]
+
{{#ask: [[Category:Functions]] [[parent::Shape||Object]] [[Concept:Current]]
 +
| headers=hide
 +
| format=template
 +
| template=ListingFields
 +
| introtemplate=ListingIntro
 +
| outrotemplate=ListingOutro
 +
| ?Description
 +
| ?PrettySince
 +
| ?PrettyRemoved
 +
}}
 +
== Enums ==
 +
{{#ask: [[Category:Enums]] [[parent::Shape]] [[Concept:Current]]
 
| headers=hide
 
| headers=hide
 +
| format=template
 +
| template=ListingFields
 +
| introtemplate=ListingIntro
 +
| outrotemplate=ListingOutro
 
| ?Description
 
| ?Description
 +
| ?PrettySince
 +
| ?PrettyRemoved
 
}}
 
}}
 +
== Supertypes ==
 +
* [[parent::Object]]
 
== Subtypes ==
 
== Subtypes ==
−
[[CircleShape]]
+
{{#ask: [[Category:Types]] [[parent::Shape]] [[Concept:Current]]
−
[[PolygonShape]]
+
| headers=hide
 +
| format=template
 +
| template=ListingFields
 +
| introtemplate=ListingIntro
 +
| outrotemplate=ListingOutro
 +
| ?Description
 +
| ?PrettySince
 +
| ?PrettyRemoved
 +
}}
 
== See Also ==
 
== See Also ==
 
* [[parent::love.physics]]
 
* [[parent::love.physics]]
−
* [[love.physics.newCircleShape]]
 
−
* [[love.physics.newPolygonShape]]
 
−
* [[love.physics.newRectangleShape]]
 
 
[[Category:Types]]
 
[[Category:Types]]
−
{{#set:Description=Shapes are objects used to control mass and collisions.
+
{{#set:Description=[[Shape|Shapes]] are objects used to control mass and collisions.}}
−
}}
+
{{#set:Since=000}}
 +
== Other Languages ==
 +
{{i18n|Shape}}

Latest revision as of 20:27, 4 January 2021

Shapes are solid 2d geometrical objects which handle the mass and collision of a Body in love.physics.

Shapes are attached to a Body via a Fixture. The Shape object is copied when this happens.

The Shape's position is relative to the position of the Body it has been attached to.

Constructors

love.physics.newChainShape Creates a new ChainShape. Added since 0.8.0
love.physics.newCircleShape Creates a new CircleShape.
love.physics.newEdgeShape Creates a new EdgeShape. Added since 0.8.0
love.physics.newPolygonShape Creates a new PolygonShape.
love.physics.newRectangleShape Shorthand for creating rectangular PolygonShapes.

Functions

Object:release Immediately destroys the object's Lua reference. Added since 11.0
Object:type Gets the type of the object as a string.
Object:typeOf Checks whether an object is of a certain type.
Shape:computeAABB Returns the points of the bounding box for the transformed shape. Added since 0.8.0
Shape:computeMass Computes the mass properties for the shape. Added since 0.8.0
Shape:destroy Explicitly destroys the Shape. Removed in 0.8.0
Shape:getBody Get the body the shape is attached to. Added since 0.7.0 Removed in 0.8.0
Shape:getBoundingBox Gets the bounding box of the shape. Removed in 0.8.0
Shape:getCategory Gets the categories this shape is a member of. Removed in 0.8.0
Shape:getCategoryBits Gets the categories as a 16-bit integer. Removed in 0.8.0
Shape:getChildCount Returns the number of children the shape has. Added since 0.8.0
Shape:getData Get the data set with setData. Removed in 0.8.0
Shape:getDensity Gets the density of the Shape. Removed in 0.8.0
Shape:getFilterData Gets the filter data of the Shape. Removed in 0.8.0
Shape:getFriction Gets the friction of this shape. Removed in 0.8.0
Shape:getMask Gets which categories this shape should NOT collide with. Removed in 0.8.0
Shape:getRadius Gets the radius of the shape.
Shape:getRestitution Gets the restitution of this shape. Removed in 0.8.0
Shape:getType Gets a string representing the Shape.
Shape:isSensor Checks whether a Shape is a sensor or not. Removed in 0.8.0
Shape:rayCast Casts a ray against the shape. Added since 0.8.0
Shape:setCategory Sets the categories this shape is a member of. Removed in 0.8.0
Shape:setData Set data to be passed to the collision callback. Removed in 0.8.0
Shape:setDensity Sets the density of a Shape. Removed in 0.8.0
Shape:setFilterData Sets the filter data for a Shape. Removed in 0.8.0
Shape:setFriction Sets the friction of the shape. Removed in 0.8.0
Shape:setMask Sets which categories this shape should NOT collide with. Removed in 0.8.0
Shape:setRestitution Sets the restitution of the shape. Removed in 0.8.0
Shape:setSensor Sets whether this shape should act as a sensor. Removed in 0.8.0
Shape:testPoint Checks whether a point lies inside the shape.
Shape:testSegment Checks whether a line segment intersects a shape. Removed in 0.8.0

Enums

ShapeType The different types of Shapes, as returned by Shape:getType.

Supertypes

Subtypes

ChainShape A ChainShape consists of multiple line segments.
CircleShape Circle extends Shape and adds a radius and a local position.
EdgeShape EdgeShape is a line segment.
PolygonShape Polygon is a convex polygon with up to 8 sides.

See Also


Other Languages

Dansk – Deutsch – English – Español – Français – Indonesia – Italiano – Lietuviškai – Magyar – Nederlands – Polski – Português – Română – Slovenský – Suomi – Svenska – Türkçe – Česky – Ελληνικά – Български – Русский – Српски – Українська – עברית – ไทย – 日本語 – 正體中文 – 简体中文 – Tiếng Việt – 한국어
More info

Retrieved from "https://love2d.org./w/index.php?title=Shape&oldid=25922"