NAME
OpenGL::Sandbox::V1 - Various OpenGL tools and utilities that depend on the OpenGL 1.x API
VERSION
version 0.02
DESCRIPTION
This module is separated from OpenGL::Sandbox in order to keep the OpenGL API dependencies less tangled. Everything specific to OpenGL 1.x that I would have otherwise included in OpenGL::Sandbox is located here, instead. The main OpenGL::Sandbox module can automatically load this module using the import tag of :V1 or :V1:all.
EXPORTABLE FUNCTIONS
MATRIX FUNCTIONS
load_identity
Alias for glLoadIdentity
setup_projection
local_matrix
local_matrix { ... };Wrap a block of code with glPushmatrix/glPopMatrix. This wrapper also checks the matrix stack depth before and after the call, warns if they don't match, and performs any missing glPopMatrix calls.
scale
scale $xyz;
scale $x, $y; # z=1
scale $x, $y, $z;Scale all axes (one argument), the x and y axes (2 arguments), or a normal call to glScale (3 arguments).
trans
trans $x, $y;
trans $x, $y, $z;Translate along x,y or x,y,z axes. Calls either glTranslate2f or glTranslate3f.
trans_scale
trans_scale $x, $y, $x, $s; # scale each by $s
trans_scale $x, $y, $x, $sx, $sy; # $sz=1
trans_scale $x, $y, $x, $sx, $sy, $sz;Combination of glTranslate, then glScale.
rotate
rotate $degrees, $x, $y, $z;
rotate x => $degrees;
rotate y => $degrees;
rotate z => $degrees;Normal call to glRotated, or x/y/z notation to rotate around that axis.
mirror
mirror 'x'; # glScale(-1, 0, 0)
mirror 'y'; # glScale(0, -1, 0)
mirror 'xyz'; # glScale(-1, -1, -1)Use glScale to invert one more more axes.
local_gl
local_gl { ... };Like local_matrix, but also calls glPushAttrib/glPopAttrib. This is expensive, and should probably only be used for debugging.
GEOMETRY PLOTTING
lines
lines { ... }; # wraps code with glBegin(GL_LINES); ... glEnd();line_strip
line_strip { ... }; # wraps code with glBegin(GL_LINE_STRIP); ... glEnd();quads
quads { ... }; # wraps code with glBegin(GL_QUADS); ... glEnd();quad_strip
quad_strip { ... }; # wraps code with glBegin(GL_QUAD_STRIP); ... glEnd();triangles
triangles { ... }; # wraps code with glBegin(GL_TRIANGLES); ... glEnd();triangle_strip
triangle_strip { ... }; # wraps code with glBegin(GL_TRIANGLE_STRIP); ... glEnd();triangle_fan
triangle_fan { ... }; # wraps code with glBegin(GL_TRIANGLE_FAN); ... glEnd();vertex
vertex $x, $y;
vertex $x, $y, $z;
vertex $x, $y, $z, $w;Call one of glVertex${N} based on number of arguments.
plot_xy
plot_xy(
$geom_mode, # optional, i.e. GL_TRIANGLES or undef
$x0, $y0, # Shortcut for many glVertex2d calls
$x1, $y1,
...
$xN, $yN,
);If $geom_mode is not undef or zero, this makes a call to glBegin and glEnd around the calls to glVertex2d.
plot_xyz
plot_xyz(
$geom_mode,
$x0, $y0, $z0,
$x1, $y1, $z1,
...
$xN, $yN, $zN,
);Like above, but call glVertex3d.
plot_st_xy
plot_st_xy(
$geom_mode,
$s0, $t0, $x0, $y0,
$s1, $t1, $x1, $y1,
...
$sN, $tN, $xN, $yN,
);Like above, but calls both glTexCoord2d and glVertex2d.
plot_st_xyz
plot_st_xyz(
$geom_mode,
$s0, $t0, $x0, $y0, $z0,
$s1, $t1, $x1, $y1, $z1,
...
$sN, $tN, $xN, $yN, $zN,
);Like above, but call both glTexCoord2d and glVertex3d.
plot_norm_st_xyz
plot_norm_st_xyz(
$geom_mode,
$nx0, $ny0, $nz0, $s0, $t0, $x0, $y0, $z0,
$nx0, $ny0, $nz0, $s1, $t1, $x1, $y1, $z1,
...
$nx0, $ny0, $nz0, $sN, $tN, $xN, $yN, $zN,
);Like above, but calls each of glNormal3d, glTexCoord2d, glVertex3d.
plot_rect
plot_rect(x0,y0, x1,y1)plot_rect3
plot_rect3(x0,y0,z0, x1,y1,z1)cylinder
cylinder($base_radius, $top_radius, $height, $radial_slices, $stacks);Plot a cylinder along the Z axis with the specified dimensions. Shortcut for "cylinder" in OpenGL::Sandbox::V1::Quadric on the default_quadric. That quadric determines whether normals or texture coordinates get generated.
sphere
sphere($radius, $radial_slices, $stacks);Plot a sphere around the origin with specified dimensions. Shortcut for "sphere" in OpenGL::Sandbox::V1::Quadric on the default_quadric.
disk
disk($inner_rad, $outer_rad, $slices, $stacks);Plot a disk around the Z axis with specified inner and outer radius. Shortcut for "disk" in OpenGL::Sandbox::V1::Quadric on the default_quadric.
partial_disk
partial_disk($inner_rad, $outer_rad, $slices, $loops, $start_angle, $sweep_degrees);Plot a wedge of a disk around the Z axis. Shortcut for "disk" in OpenGL::Sandbox::V1::Quadric on the default_quadric.
DISPLAY LISTS
compile_list
my $list= compile_list { ... };Constructs a displaylist by compiling the code in the block.
call_list
call_list($list, sub { ... });If the variable $list contains a compiled displaylist, this calls that list. Else it creates a new list, assigns it to the variable $list, and compiles the contents of the coderef. This is a convenient way of compiling some code on the first pass and then calling it every iteration after that.
COLORS
setcolor
setcolor($r, $g, $b);
setcolor($r, $g, $b, $a);
setcolor(\@rgb);
setcolor(\@rgba);
setcolor('#RRGGBB');
setcolor('#RRGGBBAA');Various ways to specify a color for glSetColor4f. If Alpha component is missing, it defaults to 1.0
color_parts
my ($r, $g, $b, $a)= color_parts('#RRGGBBAA');Convenience method that always returns 4 components of a color, given the same variety of formats as setcolor.
color_mult
my ($r, $g, $b, $a)= color_mult( \@color1, \@color2 )Multiply each component of color1 by that component of color2.
MISC DRAWING
draw_axes_xy
draw_axes_xy( $range, $unit_size, $color );
draw_axes_xy( $range, $unit_size, $colorX, $colorY );Renders the X and Y axis as lines from -$range to +$range, with a thinner lines making a grid of $unit_size squares on the X/Y plane.
$range defaults to 1. $unit_size defaults to 0.1. $color defaults to the current color.
Automatically disables textures for this operation.
draw_axes_xyz
draw_axes_xyz( $range, $unit_size, $color );
draw_axes_xyz( $range, $unit_size, $colorX, $colorY, $colorZ );Renders each of the X,Y,Z axes and the XY, XZ, YZ planes.
draw_boundbox
draw_boundbox( $x0, $y0, $x1, $y1, $color_edge, $color_to_origin );Draw lines around a rectangle, and also a line from each corner to the origin, and the section of the X and Y axes that are within the bounds of the rectangle. This is useful for marking a 2D widget relative to the current coordinate system.
AUTHOR
Michael Conrad <mike@nrdvana.net>
COPYRIGHT AND LICENSE
This software is copyright (c) 2018 by Michael Conrad.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.