ClippedCamera

A Camera that includes collision.

This node extends Camera to add collisions with Area and/or PhysicsBody nodes. The camera cannot move through colliding objects.

@GodotBaseClass

struct ClippedCamera {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

package @nogc nothrow __gshared

bool _classBindingInitialized;

struct GDNativeClassBinding;

bool opEquals(ClippedCamera other);

typeof(null) opAssign(typeof(null) n);

bool opEquals(typeof(null) n);

size_t toHash();

mixin baseCasts ;

static ClippedCamera _new();

enum ProcessMode;

enum Constants;

void addException(GodotObject node);

void addExceptionRid(RID rid);

void clearExceptions();

double getClipOffset();

long getCollisionMask();

bool getCollisionMaskBit(long bit);

double getMargin();

ClippedCamera.ProcessMode getProcessMode();

bool isClipToAreasEnabled();

bool isClipToBodiesEnabled();

void removeException(GodotObject node);

void removeExceptionRid(RID rid);

void setClipToAreas(bool enable);

void setClipToBodies(bool enable);

void setCollisionMask(long mask);

void setCollisionMaskBit(long bit, bool value);

void setMargin(double margin);

void setProcessMode(long process_mode);

bool clipToAreas [@property getter];

bool clipToAreas [@property setter];

bool clipToBodies [@property getter];

bool clipToBodies [@property setter];

long collisionMask [@property getter];

long collisionMask [@property setter];

double margin [@property getter];

double margin [@property setter];

ClippedCamera.ProcessMode processMode [@property getter];

long processMode [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Enums

Constants enum Constants
ProcessMode enum ProcessMode

Functions

addException void addException(GodotObject node): Adds a collision exception so the camera does not collide with the specified node.
addExceptionRid void addExceptionRid(RID rid): Adds a collision exception so the camera does not collide with the specified RID.
clearExceptions void clearExceptions(): Removes all collision exceptions.
getClipOffset double getClipOffset(): Returns the distance the camera has been offset due to a collision.
getCollisionMask long getCollisionMask()
getCollisionMaskBit bool getCollisionMaskBit(long bit): Returns true if the specified bit index is on. Note: Bit indices range from 0-19.
getMargin double getMargin()
getProcessMode ClippedCamera.ProcessMode getProcessMode()
isClipToAreasEnabled bool isClipToAreasEnabled()
isClipToBodiesEnabled bool isClipToBodiesEnabled()
opAssign typeof(null) opAssign(typeof(null) n)
opEquals bool opEquals(ClippedCamera other)
opEquals bool opEquals(typeof(null) n)
removeException void removeException(GodotObject node): Removes a collision exception with the specified node.
removeExceptionRid void removeExceptionRid(RID rid): Removes a collision exception with the specified RID.
setClipToAreas void setClipToAreas(bool enable)
setClipToBodies void setClipToBodies(bool enable)
setCollisionMask void setCollisionMask(long mask)
setCollisionMaskBit void setCollisionMaskBit(long bit, bool value): Sets the specified bit index to the value. Note: Bit indices range from 0-19.
setMargin void setMargin(double margin)
setProcessMode void setProcessMode(long process_mode)
toHash size_t toHash()

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

clipToAreas bool clipToAreas [@property getter]
bool clipToAreas [@property setter]: If true, the camera stops on contact with Areas.
clipToBodies bool clipToBodies [@property getter]
bool clipToBodies [@property setter]: If true, the camera stops on contact with PhysicsBodys.
collisionMask long collisionMask [@property getter]
long collisionMask [@property setter]: The camera's collision mask. Only objects in at least one collision layer matching the mask will be detected. See url=https://docs.godotengine.org/en/3.3/tutorials/physics/physics_introduction.html#collision-layers-and-masksCollision layers and masks/url in the documentation for more information.
margin double margin [@property getter]
double margin [@property setter]: The camera's collision margin. The camera can't get closer than this distance to a colliding object.
processMode ClippedCamera.ProcessMode processMode [@property getter]
long processMode [@property setter]: The camera's process callback. See processmode.

Static functions

_new ClippedCamera _new(): Construct a new instance of ClippedCamera. Note: use memnew!ClippedCamera instead.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

GDNativeClassBinding struct GDNativeClassBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(To) as(): Undocumented in source. Be warned that the author may not have intended to support it.
as inout(ToRef) as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

godot clippedcamera structs

ClippedCamera