Skip to content
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.

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

add option to set ground plane location in world coords #291

Merged
merged 1 commit into from
Aug 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions include/polyscope/options.h
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,10 @@ extern bool hideWindowAfterShow;

// Behavior of the ground plane
extern GroundPlaneMode groundPlaneMode;
extern GroundPlaneHeightMode groundPlaneHeightMode;
extern bool groundPlaneEnabled; // deprecated, but kept and respected for compatability. use groundPlaneMode.
extern ScaledValue<float> groundPlaneHeightFactor;
extern float groundPlaneHeight;
extern int shadowBlurIters;
extern float shadowDarkness;

Expand Down
1 change: 1 addition & 0 deletions include/polyscope/types.h
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ enum class BackgroundView { None = 0 };
enum class ProjectionMode { Perspective = 0, Orthographic };
enum class TransparencyMode { None = 0, Simple, Pretty };
enum class GroundPlaneMode { None, Tile, TileReflection, ShadowOnly };
enum class GroundPlaneHeightMode { Relative = 0, Absolute };
enum class BackFacePolicy { Identical, Different, Custom, Cull };

enum class PointRenderMode { Sphere = 0, Quad };
Expand Down
2 changes: 2 additions & 0 deletions src/options.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ std::string screenshotExtension = ".png";
// Ground plane / shadows
bool groundPlaneEnabled = true;
GroundPlaneMode groundPlaneMode = GroundPlaneMode::TileReflection;
GroundPlaneHeightMode groundPlaneHeightMode = GroundPlaneHeightMode::Relative;
ScaledValue<float> groundPlaneHeightFactor = 0;
float groundPlaneHeight = 0.;
int shadowBlurIters = 2;
float shadowDarkness = 0.25;

Expand Down
57 changes: 55 additions & 2 deletions src/render/ground_plane.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,18 @@ void GroundPlane::draw(bool isRedraw) {
double bboxBottom = sign == 1.0 ? std::get<0>(state::boundingBox)[iP] : std::get<1>(state::boundingBox)[iP];
double bboxHeight = std::get<1>(state::boundingBox)[iP] - std::get<0>(state::boundingBox)[iP];
double heightEPS = state::lengthScale * 1e-4;
double groundHeight = bboxBottom - sign * (options::groundPlaneHeightFactor.asAbsolute() + heightEPS);

double groundHeight = -777;
switch (options::groundPlaneHeightMode) {
case GroundPlaneHeightMode::Relative: {
groundHeight = bboxBottom - sign * (options::groundPlaneHeightFactor.asAbsolute() + heightEPS);
break;
}
case GroundPlaneHeightMode::Absolute: {
groundHeight = options::groundPlaneHeight;
break;
}
}

// Viewport
glm::vec4 viewport = render::engine->getCurrentViewport();
Expand Down Expand Up @@ -387,6 +398,16 @@ void GroundPlane::buildGui() {
return "";
};

auto heightModeName = [](const GroundPlaneHeightMode& m) -> std::string {
switch (m) {
case GroundPlaneHeightMode::Relative:
return "Relative";
case GroundPlaneHeightMode::Absolute:
return "Absolute";
}
return "";
};

ImGui::SetNextItemOpen(false, ImGuiCond_FirstUseEver);
if (ImGui::TreeNode("Ground Plane")) {

Expand All @@ -404,7 +425,39 @@ void GroundPlane::buildGui() {
}
ImGui::PopItemWidth();

if (ImGui::SliderFloat("Height", options::groundPlaneHeightFactor.getValuePtr(), -1.0, 1.0)) requestRedraw();
// Height
ImGui::PushItemWidth(80);
switch (options::groundPlaneHeightMode) {
case GroundPlaneHeightMode::Relative:
if (ImGui::SliderFloat("##HeightValue", options::groundPlaneHeightFactor.getValuePtr(), -1.0, 1.0))
requestRedraw();
break;
case GroundPlaneHeightMode::Absolute:
int iP;
float sign;
std::tie(iP, sign) = getGroundPlaneAxisAndSign();
double bboxBottom = sign == 1.0 ? std::get<0>(state::boundingBox)[iP] : std::get<1>(state::boundingBox)[iP];
double bboxHeight = std::get<1>(state::boundingBox)[iP] - std::get<0>(state::boundingBox)[iP];
if (ImGui::SliderFloat("##HeightValue", &options::groundPlaneHeight, bboxBottom - 0.5 * bboxHeight,
bboxBottom + bboxHeight)) {
requestRedraw();
}
break;
}
ImGui::PopItemWidth();
ImGui::SameLine();
ImGui::PushItemWidth(100);
if (ImGui::BeginCombo("Height##Mode", heightModeName(options::groundPlaneHeightMode).c_str())) {
for (GroundPlaneHeightMode m : {GroundPlaneHeightMode::Relative, GroundPlaneHeightMode::Absolute}) {
std::string mName = heightModeName(m);
if (ImGui::Selectable(mName.c_str(), options::groundPlaneHeightMode == m)) {
options::groundPlaneHeightMode = m;
requestRedraw();
}
}
ImGui::EndCombo();
}
ImGui::PopItemWidth();

switch (options::groundPlaneMode) {
case GroundPlaneMode::None:
Expand Down
7 changes: 7 additions & 0 deletions test/src/basics_test.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -134,5 +134,12 @@ TEST_F(PolyscopeTest, GroundPlaneTest) {
polyscope::refresh();
polyscope::show(3);

polyscope::options::groundPlaneHeightMode = polyscope::GroundPlaneHeightMode::Absolute;
polyscope::options::groundPlaneHeight = -0.3;
polyscope::show(3);

polyscope::options::groundPlaneHeightMode = polyscope::GroundPlaneHeightMode::Relative;
polyscope::show(3);

polyscope::removeAllStructures();
}