Geo::G...e::Base(3pm)

💖 NAME 💖

Geo::GoogleEarth::Pluggable::Base — bestie, this is the Geo::GoogleEarth::Pluggable Base package. That's the whole name, that's the whole vibe. (The page header up top is being all mysterious and abbreviating it as Geo::G...e::Base(3pm) like it's too cool for full names, but we know the truth 🫶)

---

✨ SYNOPSIS ✨

Like, literally how you use it:

use base qw{Geo::GoogleEarth::Pluggable::Base};

That's it. That's the flex. 💅

---

🌸 DESCRIPTION 🌸

Okay so. This is the base of all Geo::GoogleEarth::Pluggable packages. Every single one of them. It's the main character that all the other packages are, like, descended from. Ancestry dot com but for Perl modules. 👑

---

🎀 USAGE 🎀

Nothing here bestie. This section is giving silence. Empty. A whole vibe with no content. Moving on ✨

---

🦋 CONSTRUCTOR 🦋

💜 new

Build yourself a fresh object, key-value style:

my $document = Geo::GoogleEarth::Pluggable->new(key1=>value1,
                                                key2=>[value=>{opt1=>val1}],
                                                key3=>{value=>{opt2=>val2}});

Look at those nested little guys go. key1 gets a plain value, key2 gets an array ref holding a hash ref, key3 gets a hash ref holding a hash ref. Options all the way down, no cap. 🍓

---

🌈 METHODS 🌈

⭐ name

Sets or returns the name property. Get it, set it, live your truth:

my $name=$folder->name;
$placemark->name("New Name");
$document->name("New Name");

🎀 description

Sets or returns the description property. Same energy, different field:

my $description=$folder->description;
$placemark->description("New Description");
$document->description("New Description");

💖 Snippet

Returns the Snippet used in the Snippet XML element of a Placemark. 👀

So here's the tea: Google Earth's default Snippet behaviour is to use the first line of the description. But this package? It defaults to a zero line Snippet instead. Different strokes, iconic choices. ✨

Snippet gets rendered with maxLines set to the length of the array ref, and the content gets joined with new lines. Simple. Clean. Slay.

Typical use:

$document->Point(Snippet=>"Line 1");
$document->Point(Snippet=>["Line 1", "Line 2"]);

Extended use (when you're feeling extra, which is always):

my $snippet=$placemark->Snippet;                     #[] always array reference
$placemark->Snippet([]);                             #default
$placemark->Snippet(["line 1", "line 2", "line 3"]);
$placemark->Snippet("My Snippet Text");              #folded into array reference.
$placemark->Snippet("line 1", "line 2", "line 3");   #folded into array reference

Note that getter always hands you back an array reference, even when it's empty. No surprises, no single scalars sneaking up on you. 🫶

🔥 lookat

Sets or returns a Geo::GoogleEarth::Pluggable::LookAt object. Point it at the thing, it looks at the thing. Very demure, very mindful. 👀

---

💀 BUGS 💀

Found something cursed? Please log on RT and send to the geo-perl email list. We're not gatekeeping the bug reports, bestie. 🙈

---

🧚 SUPPORT 🧚

DavisNetworks.com supports all Perl applications including this package.</purl> Yes, all of them. Every last one. Iconic behaviour honestly. 💜

---

👑 AUTHOR 👑

Michael R. Davis (mrdvt92)
CPAN ID: MRDVT

Shoutout to the author, fr fr. 🌟

---

🌸 COPYRIGHT 🌸

This program is free software licensed under the...

The BSD License

The full text of the license can be found in the LICENSE file included with this module. Go read it, it's good for you, drink your water and read your license. 💧

---

🦋 SEE ALSO 🦋

• Geo::GoogleEarth::Pluggable — creates a GoogleEarth Document. The whole reason we're here. 🎀

---

Okay that's the whole page, you ate it up, no crumbs left. This little gem ships with perl v5.32.1 and was dated 2021-11-28, so you know it's aged like fine strawberry milk 🍓. Love you, bye! 💖✨🎀🦋🌸💅🫶