Skip to content

CenterQuad: new class javadoc #1684

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 1, 2021
Merged

CenterQuad: new class javadoc #1684

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3406685
CenterQuad: rewrote the class javadoc from scratch
stephengold Nov 25, 2021
109624d
CenterQuad: improve the javadoc style
stephengold Dec 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions jme3-vr/src/main/java/com/jme3/scene/CenterQuad.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2009-2010 jMonkeyEngine
* Copyright (c) 2009-2021 jMonkeyEngine
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
Expand Down Expand Up @@ -36,11 +36,15 @@
import com.jme3.scene.VertexBuffer.Type;

/**
* <code>Quad</code> represents a rectangular plane in space
* defined by 4 vertices. The quad's lower-left side is contained
* at the local space origin (0, 0, 0), while the upper-right
* side is located at the width/height coordinates (width, height, 0).
*
* A static, indexed, Triangles-mode mesh for an axis-aligned rectangle in the
* X-Y plane.
*
* <p>The rectangle extends from (-width/2, -height/2, 0) to
* (width/2, height/2, 0) with normals set to (0,0,1).
*
* <p>This differs from {@link com.jme3.scene.shape.Quad} because it puts
* (0,0,0) at the rectangle's center instead of in a corner.
*
* @author Kirill Vainer
*/
public class CenterQuad extends Mesh {
Expand Down